| # Contributing to Serde |
| |
| Serde welcomes contribution from everyone in the form of suggestions, bug |
| reports, pull requests, and feedback. This document gives some guidance if you |
| are thinking of helping us. |
| |
| ## Submitting bug reports and feature requests |
| |
| Serde development is spread across lots of repositories. In general, prefer to |
| open issues against the main [serde-rs/serde] repository unless the topic is |
| clearly specific to JSON. |
| |
| [serde-rs/serde]: https://github.com/serde-rs/serde |
| |
| When reporting a bug or asking for help, please include enough details so that |
| the people helping you can reproduce the behavior you are seeing. For some tips |
| on how to approach this, read about how to produce a [Minimal, Complete, and |
| Verifiable example]. |
| |
| [Minimal, Complete, and Verifiable example]: https://stackoverflow.com/help/mcve |
| |
| When making a feature request, please make it clear what problem you intend to |
| solve with the feature, any ideas for how Serde could support solving that |
| problem, any possible alternatives, and any disadvantages. |
| |
| ## Running the test suite |
| |
| We encourage you to check that the test suite passes locally before submitting a |
| pull request with your changes. If anything does not pass, typically it will be |
| easier to iterate and fix it locally than waiting for the CI servers to run |
| tests for you. |
| |
| The test suite requires a nightly compiler. |
| |
| ```sh |
| # Run the full test suite, including doc test and compile-tests |
| cargo test |
| ``` |
| |
| ## Conduct |
| |
| In all Serde-related forums, we follow the [Rust Code of Conduct]. For |
| escalation or moderation issues please contact Erick (erick.tryzelaar@gmail.com) |
| instead of the Rust moderation team. |
| |
| [Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct |
