Contributing to Litmus
Thanks for your interest in contributing to Litmus and help improve the project!
Where to Begin!
If you have any queries or requests about Litmus please create an issue on GitHub. If you want to comment or ask questions to the contributors start by joining our community and drop your questions in the #litmus channel.
If you want to do code contributions but you are fairly new to the tech stack we are using! Check out the Development Guide to get a reference and help get started.
We welcome contributions of all kinds
- Development of features, bug fixes, and other improvements.
- Documentation including reference material and examples.
- Bug and feature reports.
Steps to Contribute
Fixes and improvements can be directly addressed by sending a Pull Request on GitHub. Pull requests will be reviewed by one or more maintainers and merged when acceptable.
We ask that before contributing, please make the effort to coordinate with the maintainers of the project before submitting large or high impact PRs. This will prevent you from doing extra work that may or may not be merged.
Use your judgement about what constitutes a large change. If you aren't sure, send a message to the #litmus-dev slack or submit an issue on GitHub.
Sign your work with Developer Certificate of Origin
To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.
See the DCO file for the full text of what you must agree to.
To successfully sign off your contribution you just add a line to every git commit message:
Signed-off-by: Joe Smith <firstname.lastname@example.org>
Use your real name (sorry, no pseudonyms or anonymous contributions.)
If you set your
user.email git configs, you can sign your commit automatically with
git commit -s. You can also use git aliases like
git config --global alias.ci 'commit -s'. Now you can commit with git ci and the commit will be signed.
Submitting a Pull Request
To submit any kinds of improvements, please consider the following:
- Submit an issue describing your proposed change. If you are just looking to pick an open issue do so from a list of good-first-issues maintained here.
- We would promptly respond back to your issue
- Fork this repository, develop and test your code changes. See the Highlighted Repositories section below to choose which area you would like to contribute to.
- Create a
feature branchfrom your forked repository and submit a pull request against this repo’s main branch.
- If you are making a change to the user interface (UI), include a screenshot of the UI changes.
- Follow the relevant coding style guidelines
- Your branch may be merged once all configured checks pass, including:
Pull Request Checklist :
- Rebase to the current master branch before submitting your pull request.
- Commits should be as small as possible. Each commit should follow the checklist below:
- For code changes, add tests relevant to the fixed bug or new feature
- Pass the compile and tests in CI
- Commit header (first line) should convey what changed
- Commit body should include details such as why the changes are required and how the proposed changes
- DCO Signed
- If your PR is not getting reviewed or you need a specific person to review it, please reach out to the Litmus contributors at the Litmus slack channel
You can choose from a list of sub-dependent repos to contribute to, a few highlighted repos that Litmus uses are:
The litmus community will have a weekly contributor sync-up on Tuesdays 16.00-16.30 IST / 12.30-13.00 CEST