Skip to content

Latest commit

 

History

History
44 lines (24 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

44 lines (24 loc) · 1.23 KB

Contributing to skunk 🦨

First off, thank you for considering contributing to skunk 🦨.

There are plenty of issues to work on. Look for the good first issue label if you want something easier first.

If your contribution is not straightforward, please first discuss the change you wish to make in the relevant issue, or create a new one, if there isn't one already.

Reporting issues

Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.

Try to use a clear title, and describe your problem with complete sentences.

Workspace Setup

skunk currently requires rust nightly: rustup override set nightly.

The project's README has some guidance on how to setup the project for development.

Workflow

After making your changes make sure your changes compile and all tests pass with cargo test --all-features --workspace.

Format the code with cargo fmt.

Pull requests

Try to open one pull request per feature, patch, etc.