When contributing to the development of Remote Settings Client, create a new issue and make sure with the maintainers before making a change that the change is really needed.
Please note we have a Code of Conduct, please follow it in all your interactions with the project.
There are many ways you can contribute to Remote Settings Client, and all of them involve creating issues in Remote Settings Github Project. This is the entry point for your contribution.
To create an effective and high quality ticket, try to put the following information on your issue:
A detailed description of the issue or feature request
- For issues, please add the necessary steps to reproduce the issue.
- For feature requests, add a detailed description of your proposal and the motivation behind working on the feature.
Keep your issue status updated here
- Ensure your code compiles. Run
cargo testbefore creating the pull request. - If you're adding new external API, it must be properly documented. Run
cargo doc --opento see crate documentation - Create branches with format - "issue[issue#]_[short_description]"
- Checklist before merging PR for a particular code change or feature
- Unit Testing, CI tests passing
- Documentation (Update README, crates.io)
- Rust best practices followed
- PR approval
- While merging the PR, select "Squash and merge" option to avoid adding unnecessary commits from your branch to the main branch