While the following guidelines are not an absolute requirement, writing your code by these standards will ensure greater compatibility with the ARK Ecosystem and increases the likelihood your pull request will be accepted.
All additions and pull requests need to meet at least the following conditions:
- If adding a new feature, the feature was previously discussed with the team.
- Everything you added, modified or removed is covered by tests and has sufficient coverage.
- All your code is following the code style guidelines specified in the project.
Dos and Don’ts
Do commit features, refactors and additions to a branch instead of
developdirectly and send a PR from your branch.
- Don’t commit console.logs, debugging or related functions to your branch. They are only of value during local development and differ for each developer.
Do send pull requests that have an issue attached to them. In the body of your request, use
Resolves [link-to-issue]to indicate the issue you’re resolving with your request.
- Don’t send pull requests without an issue. First, open an issue, then send a pull request.
Do send pull requests that come from
- Don’t send pull requests that come from master or branches that have non-descriptive names. Switch to a more descriptive branch before committing.
- Do send pull requests that add new features that were previously discussed.
- Don’t send pull requests that add new features without any previous discussion about the usefulness, implementation or implications of adding it.
- Do send pull requests that improve code readability.
- Don’t send pull requests that improve code readability to your liking. Follow the standards that are specified in the project. Should you have questions, refer to our existing codebases, or contact us on slack.
- Do send pull requests that improve stability.
- Don’t send pull requests that improve stability by replacing dependencies. Without discussion, this can lead to breaking changes.
- Do send pull requests that improve test coverage.
- Don’t send pull requests that improve test coverage by refactoring major internal parts. If your branch contains significant changes, ensure that all tests pass before submitting your pull request, even tests not directly related to your package.
Issues & Pull Requests
When you think your contribution is ready and you would like to submit a pull-request, remember first to open an issue and then send a pull request that mentions the issue by making use of closing-issues-using-keywords.
When your pull request gets merged the issue will be automatically closed, and a connection be made between those two which makes it easier to figure out which issues and pull requests are related to each other.
If your PR fixes a bug or resolves a feature request, be sure to reference the issue with a keyword. Read more about keywords at the official GitHub docs.
Things We DO NOT Accept as Additions to Any Applications or Packages
The ARK Team distances itself from anything that is related to payouts by delegates or voter calculations.
If the feature you would like to add contains anything that adds functionality to calculate or process payouts to voters in this way, consider creating an extension using plugins or our SDKs to implement it yourself.