|
| 1 | +# Contributing to mutagen |
| 2 | + |
| 3 | +Hi there! So you want to join the mutagen project or at least know what it entails? Welcome and read on! |
| 4 | + |
| 5 | +## Getting started |
| 6 | + |
| 7 | +High level approach: |
| 8 | + |
| 9 | +1. Find something to fix/improve |
| 10 | +2. Change code, tests, docs, whatever |
| 11 | +3. If you changed code, run `cargo test` (once we have a test suite, that is) both in the `mutagen/` dir and the `plugin/` subdirectory. |
| 12 | + If you cannot get the code to build / tests to pass, don't fret, just mark your contribution as work in progress ("WIP"). |
| 13 | +4. Open a pull request. For that you need to fork the repository. See [GitHub's help page](https://help.github.com/articles/fork-a-repo/) |
| 14 | + for more information. |
| 15 | + |
| 16 | +### Finding something to fix/improve |
| 17 | + |
| 18 | +All issues on mutagen are mentored, if you want help with an issue just ask @llogiq. |
| 19 | + |
| 20 | +Some issues are easier than others. The [good first issue](https://github.com/llogiq/mutagen/labels/good%20first%20issue) |
| 21 | +label can be used to find the easy issues. If you want to work on an issue, please leave a comment to have it assigned |
| 22 | +to you. |
| 23 | + |
| 24 | +### Writing code, tests, docs, etc. |
| 25 | + |
| 26 | +All contributions are equally welcome, whether it's refactorings for a more readable codebase, fixing a bug or implementing |
| 27 | +new functionality, adding tests, documentation or setting up or improving CI, we'll be happy to have your contributions. |
| 28 | + |
| 29 | +### Getting your contribution into mutagen |
| 30 | + |
| 31 | +Contributions to mutagen should be made in the form of GitHub pull requests. Each pull request will |
| 32 | +be reviewed by a core contributor (someone with permission to land patches) and either landed in the |
| 33 | +main tree or given feedback for changes that would be required. |
| 34 | + |
| 35 | +All code in this repository is under either the [Apache License 2.0](LICENSE.Apache2) or the [MIT License](LICENSE.MIT). |
| 36 | + |
| 37 | +## Conduct |
| 38 | + |
| 39 | +We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html). |
| 40 | + |
| 41 | + |
| 42 | +<!-- adapted from https://github.com/rust-lang-nursery/rust-clippy/blob/master/CONTRIBUTING.md --> |
0 commit comments