2016-06-22 14:03:39 +00:00
|
|
|
# Contributing to Serde
|
|
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
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.
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
## Submitting bug reports and feature requests
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
Serde development is spread across lots of repositories, but this serde-rs/serde
|
|
|
|
|
repository is always a safe choice for opening any issues related to Serde.
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
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].
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
[Minimal, Complete, and Verifiable example]: https://stackoverflow.com/help/mcve
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
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.
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
## Running the test suite
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
##### In the [`serde`] directory
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
# Test all the example code in Serde documentation
|
2021-06-12 20:34:45 +00:00
|
|
|
cargo test --features derive
|
2017-10-22 22:46:54 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
##### In the [`test_suite`] directory
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
# Run the full test suite, including tests of unstable functionality
|
2021-06-12 20:38:23 +00:00
|
|
|
cargo +nightly test --features unstable
|
2017-10-22 22:46:54 +00:00
|
|
|
```
|
|
|
|
|
|
2021-06-12 20:38:23 +00:00
|
|
|
Note that this test suite currently only supports running on a nightly compiler.
|
|
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
[`serde`]: https://github.com/serde-rs/serde/tree/master/serde
|
|
|
|
|
[`test_suite`]: https://github.com/serde-rs/serde/tree/master/test_suite
|
|
|
|
|
|
|
|
|
|
## Conduct
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2017-10-22 22:46:54 +00:00
|
|
|
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.
|
2016-06-22 14:03:39 +00:00
|
|
|
|
2020-09-05 20:09:37 +00:00
|
|
|
[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct
|
