Contribution Guidelines - ajuna-network/Polkadot.Unity.SDK GitHub Wiki

Welcome Contributors!

We are thrilled that you are interested in contributing to the Polkadot Unity SDK! Your contributions are essential for keeping the SDK robust, up-to-date, and user-friendly. This document will guide you through the contribution process.

How to Contribute

Reporting Bugs or Issues

  1. Check Existing Issues: Before creating a new issue, please check if it has already been reported.
  2. Create a New Issue: If your issue is new, use the GitHub Issues page to report it. Please provide as much detail as possible to help us understand and address the issue effectively.

Feature Requests

  1. Search for Existing Requests: Look for similar proposals before submitting a new one.
  2. Submit Your Request: Use the GitHub Issues page to submit your feature request. Include a clear description and the potential benefits of your proposed feature.

Submitting Code Changes

  1. Fork the Repository: Start by forking the Polkadot Unity SDK repository on GitHub.
  2. Create a Branch: Make your changes in a new branch in your fork.
  3. Code Guidelines: Ensure your code adheres to the existing coding style and standards.
  4. Testing: Test your changes thoroughly to ensure they work as expected and do not introduce new bugs.
  5. Submit a Pull Request: Once your changes are ready, submit a pull request (PR) to the main repository. In your PR, include a clear description of the changes and any relevant issue numbers.

Documentation

  1. Improvements and Corrections: Enhancements and fixes to documentation are greatly appreciated. Follow the same process as code contributions for submitting these changes.

Code of Conduct

As contributors and maintainers, we are committed to fostering a welcoming and respectful community. Please adhere to our Code of Conduct in all your interactions within the project.

Review Process

After submitting your contribution:

  1. Community Review: The community and maintainers will review your submission. Be open to feedback and ready to make adjustments if necessary.
  2. Approval and Merge: If your contribution is approved, it will be merged into the project.

Stay Involved

Contributing is more than just code! Stay active in discussions, help answer questions, and engage with the community. Your insights and feedback are valuable to the project's growth.

Questions and Support

If you have questions about the contribution process, feel free to reach out via our Support and Contact page.

Thank You!

Your contributions make the Polkadot Unity SDK better for everyone. We appreciate your efforts to help grow and improve this community-driven project!