You can contribute to Coingrig Mobile Wallet in various ways, including:
-
Reporting bugs or issues on GitHub. Please make sure to include fill in all the details in the issue template to make sure the issue can be addressed as quickly as possible.
-
Submitting improvements to the documentation Updates, enhancements, new guides, spelling fixes...
-
Helping other people on the discussions.
-
Looking at existing issues and adding more information, particularly helping to reproduce the issues.
-
Submitting a pull request with a bug fix or an improvement.
The Coingrig Mobile Wallet GitHub repository contains the packages that make up Coingrig Mobile Wallet.
The develop branch of the repository should be kept releasable at any time, even if it is not the realease branch.
Keeping the develop releasable means that changes merged to it need to be:
-
Backwards compatible: Coingrig Mobile Wallet should work with every currently supported Coingrig Wallet version. If the code you're adding depends on a feature only present in newer or unreleased Coingrig Wallet versions, it needs to check which version is being used and not assume the latest version is being used.
-
Non-breaking: If code that is unreleasable or fails the test suite ends up in
develop, it should be reverted. -
Tested: Always include a test plan in pull requests. Do not merge code that doesn't pass all automated tests.
To submit a pull request:
-
Fork the repository and create a feature branch. (Existing contributors can create feature branches without forking. Prefix the branch name with
@your-github-username/.) -
Write the description of your pull request. Make sure to include a test plan and test your changes.
-
Wait for a review and adjust the code if necessary.