Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 6.42 KB

CONTRIBUTING.md

File metadata and controls

84 lines (56 loc) · 6.42 KB
Raw

👋 Hi there,

Thank you for considering to contribute to Arcana Network SDKs!

We believe that no contribution is small. We'd be delighted to hear from you and learn more about how we can build a robust platform at Arcana Network. Our mission is to enable dApps developers to build Web3 applications quickly, securely and with full user data privacy.

License

All contributions to Arcana Network SDKs are released under the MIT License

Contributing to Arcana Network SDKs

In this guide, you will learn about the do's and don'ts for making your contributions in Arcana Network SDKs.

You can contribute in various ways:

  1. Report bugs.
  2. Report security and privacy vulnerabilities.
  3. Suggest an optimization or a more efficient way to implement a function/feature that is more robust, secure and faster than the existing implementation.
  4. Share your unique use case, additional feature request.
  5. Fix an existing bug or open GitHub issue and issue a pull request.
  6. Review any open pull requests and suggest improvisation where applicable.
  7. Vote on open GitHub issues to help us prioritize the ones that are more in demand.
  8. Add new test cases for validating security and privacy scenarios.
  9. Contribute to documentation by sharing feedback regarding missing information, incorrect information or code samples that work better than those documented. Any documentation feedback that helps new users onboard Arcana Network SDK is most welcome.

General Guidelines

  • Every contribution must be associated with an open GitHub issue.

  • Before you report an issue, please refer to the list of open issues for the Arcana Network SDKs. Refer to the SDK repository Issues section at GitHub.

  • If you do not see the issue already reported in the list of open issues, raise a new one. Use the GitHub issue template and fill in all the required details about the issue that you are facing. Provide screenshots and steps to reproduce it for a speedy investigation and redressal by Arcana Network developers and other community enthusiasts.

  • Pull Requests (PR) are most welcome as contributions.

    • If you plan to submit a pull request, first raise an issue and assign it to yourself. Describe what you plan to provide / add or change in your PR. It could be a feature, an optimization or plugging in a security vulnerability or privacy issue.
    • For a complex or larger change, we highly recommend that you first discuss with the core Arcana development team members and then implement it.
    • Make sure that you fork the SDK repository, fix the issue in your fork, test it and commit it. Only then, issue a PR.
    • It is expected that you will follow the coding styles, testing processes specific to respective Arcana Network SDK repository and not deviate from the existing code writing style unless there is a good reason for it.
    • Add new test cases to automate testing your PR changes during CI cycles and to ensure nothing breaks in earlier functionality due to the changes that you introduced.
    • Refer to the SDK Quick Start, Usage and Reference Guides available at Arcana Network Documentation Website
    • Please make sure you provide all the details in the pull request template regarding the issue you fixed and the approach that was taken for solving it.
    • We will review all PRs raised by any contributor and revert back if further action is needed on their part.
    • Once approved, a PR will be merged into the Arcana Network SDK repository dev branch in the code base. The updates will be merged and released from the main branch as per Arcana Network validation and release cycles / plans and product management priorities.

  • For complex issues, or if you are not sure about an issue that you are facing, and would like to discuss it first, feel free to drop us an email.

  • You can also check out Arcana Forum, Discord for any related discussions that might help you get unblocked while using Arcana Network SDKs.

Reporting Security and Privacy Vulnerabilities

At Arcana Network, our mission is user data privacy and secure access. We organize bug bounty programs from time to time. If you find any security, privacy or data availability related vulnerability, please contact us immediately.

We would be happy to work with you and get any valid vulnerability addressed asap. Once confirmed and addressed, we would also like to publicly thank you for your contribution or keep it anonymous if you wish stay anonymous.

GitHub Issues and Tracking

Arcana product management team actively monitors and prioritizes the issues raised via GitHub. Make sure you fill in all requisite details that are necessary for reproducing, triaging and solving the issue.

Refer to Arcana Network Roadmap to understand our current release priorities and plans going forward.

Do

  1. Read and follow open source contribution guidelines whether you are a new open source contributor or a veteran.
  2. Encourage 'builder's' attitude and a welcoming environment. Please follow the standard contributor's code of conduct guidelines.
  3. Use meaningful and crisp GitHub commit messages.

Do Not...

  1. Do not open new issues that are queries.
  2. Do not submit PRs that are incomplete, not tested, deviate from SDK coding styles.
  3. Do not publicly report any security, privacy or robustness issues.
  4. Do not report any performance issue in subjective text. Share numbers and details in a quantitative manner along with expected numbers.

References