Thank you for investing your time in contributing to our project!
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Use the table of contents icon on the top of this document to get to a specific section of this guide quickly.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
To navigate our codebase with confidence, see our sandbox documentation.
Most of our code in written in Solidy and Python. Our documentation is mainly written in AsciiDoc and will be compiled automatically to HTML once the change has been commited on the main branch. The are some minor documents written in Markdown.
If you spot a problem with our code or the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
How to get an development environment set up on your local machine see here. Once you are ready create a working branch and start with your changes!
Commit the changes once you are happy with them.
When you're finished with the changes, create a pull request, also known as a PR.
- Please make sure you have read and signed our CLA (contributor license agreement) before you submit your first PR. You can sign the CLA by adding a comment to the PR with the following text:
I have read the CLA Document and I hereby sign the CLA
. Our CLA assistant will add comment to your PR as soon as you open it in case you have not signed yet. - Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉🎉 The Etherisc team thanks you ✨.
This document was inspired by the GitHub docs contributing guide.