Antimony welcomes contribution from everyone. Here are the guidelines if you are thinking of helping us:
Contributions to Antimony or its dependencies should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required. All contributions should follow this format, even those from core contributors.
Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.
Head over to Antimony Roadmap to find
good tasks to help us with. If you come across words or jargon that do not make
sense, please check the introduction first. If there's no
matching entry, please make a pull request to add one with the content TODO
so we can correct that!
-
Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.
-
Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
-
If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review on gitter.im/antimony-rs.
-
Add tests relevant to the fixed bug or new feature.
For specific git instructions, see GitHub workflow 101.
In all Antimony-related forums, we follow the Rust Code of Conduct. For escalation or moderation issues, please contact Mohammed ([email protected]) and Samir ([email protected]).
Antimony contributors frequent the Antimony channel on gitter.im.