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. In general, prefer to
10open issues against the main [serde-rs/serde] repository unless the topic is
11clearly specific to JSON.
12
13[serde-rs/serde]: https://github.com/serde-rs/serde
14
15When reporting a bug or asking for help, please include enough details so that
16the people helping you can reproduce the behavior you are seeing. For some tips
17on how to approach this, read about how to produce a [Minimal, Complete, and
18Verifiable example].
19
20[Minimal, Complete, and Verifiable example]: https://stackoverflow.com/help/mcve
21
22When making a feature request, please make it clear what problem you intend to
23solve with the feature, any ideas for how Serde could support solving that
24problem, any possible alternatives, and any disadvantages.
25
26## Running the test suite
27
28We encourage you to check that the test suite passes locally before submitting a
29pull request with your changes. If anything does not pass, typically it will be
30easier to iterate and fix it locally than waiting for the CI servers to run
31tests for you.
32
33The test suite requires a nightly compiler.
34
35```sh
36# Run the full test suite, including doc test and compile-tests
37cargo test
38```
39
40## Conduct
41
42In all Serde-related forums, we follow the [Rust Code of Conduct]. For
43escalation or moderation issues please contact Erick ([email protected])
44instead of the Rust moderation team.
45
46[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct
47