Welcome! We are delighted that you want to contribute to Iter8! 💖
As you get started, you are in the best position to give us feedback on areas of our project that we need help with including:
- Problems found during setup of Iter8
- Gaps in our quick start guide or other tutorials and documentation
- Bugs in our test and automation scripts
If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know!
Ways to Contribute¶
We welcome many different types of contributions including:
- Iter8 documentation/tutorials
- New features
- Builds, CI
- Bug fixes
- Web design for https://iter8.tools
- Communications/social media/blog posts
- Reviewing pull requests
Come to Iter8 Community Meetings!¶
Find an Issue¶
Iter8 issues are managed centrally here.
We have good first issues for new contributors and help wanted issues suitable for any contributor. Issued labeled good first issue have extra information to help you make your first contribution. Issues labeled help wanted are issues suitable for someone who isn't a core maintainer and is good to move onto after your first pull request.
Sometimes there won’t be any issues with these labels. That’s ok! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can reach out to us over the Iter8 Slack workspace for help finding something to work on.
Once you see an issue that you'd like to work on, please post a comment saying that you want to work on it. Something like "I want to work on this" is fine.
Ask for Help¶
The best ways to reach us with a question when contributing is to ask on:
- The original GitHub issue
#developmentchannel in the Iter8 Slack workspace
- Bring your questions to our community meetings
Pull Request Lifecycle¶
- Your PR is associated with one (and infrequently, with more than one) GitHub issue. You can start the submission of your PR as soon as this issue has been created.
- Follow the standard GitHub fork and pull request process when creating and submitting your PR.
- The associated GitHub issue might need to go through design discussions and may not be ready for development. Your PR might require new tests; these new or existing tests may not yet be running successfully. At this stage, keep your PR as a draft, to signal that it is not yet ready for review.
- Once design discussions are complete and tests pass, convert the draft PR into a regular PR to signal that it is ready for review. Additionally, post a message in the
#developmentSlack channel of the Iter8 Slack workspace with a link to your PR. This will expedite the review.
- You can expect an initial review within 1-2 days of submitting a PR, and follow up reviews (if any) to happen over 2-5 days.
- Use the
#developmentSlack channel of Iter8 Slack workspace to ping/bump when the pull request is ready for further review or if it appears stalled.
- Iter8 releases happen frequently. Once your PR is merged, you can expect your contribution to show up live in a short amount of time at https://iter8.tools.
Sign Your Commits¶
Licensing is important to open source projects. It provides some assurances that the software will continue to be available based under the terms that the author(s) desired. We require that contributors sign off on commits submitted to our project's repositories. The Developer Certificate of Origin (DCO) is a way to certify that you wrote and have the right to contribute the code you are submitting to the project.
You sign-off by adding the following to your commit messages. Your sign-off must match the git user and email associated with the commit.
This is my commit message Signed-off-by: Your Name <email@example.com>
Git has a
-s command line option to do this automatically:
git commit -s -m 'This is my commit message'
If you forgot to do this and have not yet pushed your changes to the remote repository, you can amend your commit with the sign-off by running
git commit --amend -s