1# Contributing to Serde CBOR 2Thanks for your interest! 3There are many ways to help: 4 5* write an issue about a problem you encountered 6* submit a pull request 7* add documentation and examples 8 9## Pull Requests 10 11Code should be easy to understand and documented. 12For new features and fixed bugs please add a test to one of the files in `test/`. 13The tests are run on Travis CI to catch regressions early. 14Format your code with `cargo fmt` before committing. 15Currently Serde CBOR does not contain `unsafe` code and I would like to keep it this way. 16 17## Making a Release 18 19* [ ] Make sure the crate compiles and all tests pass. 20* [ ] (Optional) Test that the fuzzer works and fuzz the crate for some time. 21* [ ] Write a list with all changes made since the last release 22* [ ] Increment the version number in `Cargo.toml` and the `README.md`. Bugfixes increase the patch version while new features or an increased minimum Rust version require a new minor version. 23* [ ] Check that the file `examples/readme.rs` and the example from the `README.md` match. 24* [ ] Commit the changes. 25* [ ] Add a git tag with the new version number: 26 `git tag "v42.0.2"` 27* [ ] Push the changes: `git push --tags` 28* [ ] Run `cargo publish` 29* [ ] Add a new release to GitHub with a list of changes.