How to Contribute!
You Rock!
First off, thank you for considering contributing to the Autonomys Network. It's through the amazing collaboration of people like yourself that truly make the open source community amazing.
Help Us Help You Help Us!
Following these guidelines shows that you respect the time of the developers who maintain this open source project. In return, they should reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
What Can I Contribute?
We are a fully open source project, meaning we welcome all kinds of contributions from the community. Here are a few examples of contributions that we are open to:
- Add Content: Writing a nice guide? Submit it on the forum guides.
- Bug Reports & Fixes: Find a bug or error? Let us know where it's hiding. Report it at the support forum.
- Feature Requests & Implementations: Looking for a new feature? Share your ideas so we can improve.
If you have something that is not listed, try to be as descriptive as possible and feel free to submit the pull request.
Ground Rules
Please refer to our Code of Conduct.
Your First Contribution
Simple Fix
Please follow this pathway for minor contributions such as spelling errors, typos, rewording, etc.
If you are adding entirely new pages, features, etc, then please refer to the Advanced portion of this section.
- Go to the Autonomys Documentation, and find the page that you would like to change.
- Scroll to the bottom and click
Edit this page
. - This will open the page in GitHub’s web editor.
- Once you are satisfied with your changes, click the ‘Commit changes…’ button in the top right, fill Commit message and Extended description.
- Click
Create Pull Request
When you submit changes through the web editor, GitHub automatically creates a fork of the repository under your account <your_github_name>/subspace-docs
and opens a pull request. While this method is convenient for quick edits, it has limitations for more complex contributions.
Congratulations! You have just submitted your first pull request! Please provide some time for a maintainer to view your pull request and approve it, or request adjustments.