Thank you for considering contributing to this project! We appreciate your time and effort in helping improve our work. Below are guidelines to streamline the contribution process, so please read them carefully. And don’t forget to join our Telegram for updates and community support!
Following these guidelines shows respect for the maintainers’ time, and they’ll reciprocate by giving thoughtful attention to your issues, reviewing your changes, and supporting you in finalizing pull requests.
Before you start contributing, please check the Issue Tracker to see if there are any existing issues that match what you are intending to do. If the issue doesn't exist, please create it.
If you are creating a new issue, please provide a descriptive title and detailed description. If possible, include a code sample or an executable test case demonstrating the expected behavior that is not occurring. The issue will then be analyzed by the maintainers and give you the green light to continue.
Once you've found an issue to work on, the next step is to fork the Semaphore Stellar repo and clone it to your local machine. This is necessary because you won't have push access to the main repo.
When you're ready to start coding, create a new branch on your cloned repo. It's important to use a separate branch for each issue you're working on. This keeps your changes separate in case you want to submit more than one contribution.
Please use meaningful names for your branches that clearly indicate the purpose of your work. Since this is a documentation repository, use prefixes such as docs or research. For example, if you're working on a CONTRIBUTING.md file, you might name your branch docs/contributing-guide.
As you're making changes, make sure you follow the coding conventions used throughout the Semaphore Stellar project. Consistent code style makes it easier for others to read and understand your code.
Once your changes are ready, commit them and push the branch to your forked repo on GitHub. Then you can open a pull request from your branch to the main branch of the Semaphore Stellar docs repo.
When you submit the pull request, please provide a clear, detailed description of the changes you've made. If you're addressing a specific issue, make sure you reference it in the description.
Your pull request will be reviewed by the maintainers of Semaphore Stellar. They may ask for changes or clarification on certain points. Please address their comments and commit any required changes to the same branch on your repo.
Thank you for considering to contribute to Semaphore Stellar. Your contribution is invaluable to us. We hope this guide makes the contribution process clear and answers any questions you might have. If not, feel free to ask on Telegram.