Filing an Issue¶
This is the way to report non-security related issues and also to request features.
Fork the repository on GitHub.
Create a new branch for your work.
Make your changes (see below).
Send a GitHub Pull Request to the
Step 3 is different depending on if you are contributing to the code base or documentation.
coverageif you don’t have them already.
Run run_tests.py which is located in the project directory. If any tests fail, and you are unable to diagnose the reason, please refer to Filing an Issue. If you are working on
regtest, run a local regtest node with a REST API and run tests using the
Complete your patch and write tests to verify your fix or feature is working. Please try to reduce the size and scope of your patch to make the review process go smoothly.
Run the tests again and make any necessary changes to ensure all tests pass.
Add any changes to the Unreleased section of HISTORY.rst.
Enter the docs directory.
Make your changes to any files in
make clean && make html. This will generate html files in a new
Open the generated pages and make any necessary changes to the
.rstfiles until the documentation looks properly formatted.