1# Contributing to Serde 2 3Serde welcomes contribution from everyone in the form of suggestions, bug 4reports, pull requests, and feedback. This document gives some guidance if you 5are thinking of helping us. 6 7## Submitting bug reports and feature requests 8 9Serde development is spread across lots of repositories, but this serde-rs/serde 10repository is always a safe choice for opening any issues related to Serde. 11 12When reporting a bug or asking for help, please include enough details so that 13the people helping you can reproduce the behavior you are seeing. For some tips 14on how to approach this, read about how to produce a [Minimal, Complete, and 15Verifiable example]. 16 17[Minimal, Complete, and Verifiable example]: https://stackoverflow.com/help/mcve 18 19When making a feature request, please make it clear what problem you intend to 20solve with the feature, any ideas for how Serde could support solving that 21problem, any possible alternatives, and any disadvantages. 22 23## Running the test suite 24 25We encourage you to check that the test suite passes locally before submitting a 26pull request with your changes. If anything does not pass, typically it will be 27easier to iterate and fix it locally than waiting for the CI servers to run 28tests for you. 29 30##### In the [`serde`] directory 31 32```sh 33# Test all the example code in Serde documentation 34cargo test --features derive 35``` 36 37##### In the [`test_suite`] directory 38 39```sh 40# Run the full test suite, including tests of unstable functionality 41cargo +nightly test --features unstable 42``` 43 44Note that this test suite currently only supports running on a nightly compiler. 45 46[`serde`]: https://github.com/serde-rs/serde/tree/master/serde 47[`test_suite`]: https://github.com/serde-rs/serde/tree/master/test_suite 48 49## Conduct 50 51In all Serde-related forums, we follow the [Rust Code of Conduct]. For 52escalation or moderation issues please contact Erick (erick.tryzelaar@gmail.com) 53instead of the Rust moderation team. 54 55[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct 56