Skip to content

Latest commit

 

History

History
61 lines (32 loc) · 3.38 KB

contributing.md

File metadata and controls

61 lines (32 loc) · 3.38 KB
Raw

Contributing to the HIP Subnet

Thank you for your interest in contributing to the HIP Subnet! We welcome contributions from the community to help improve and expand the capabilities of the subnet. By contributing, you can help create a powerful human intelligence layer within the Bittensor ecosystem.

Ways to Contribute

There are several ways you can contribute to the HIP Subnet:

  • Bug Reports: If you encounter any bugs or issues while using the HIP Subnet, please submit a detailed bug report. Include steps to reproduce the issue, the expected behavior, and any relevant error messages or logs.

  • Feature Requests: If you have ideas for new features or improvements to the HIP Subnet, we encourage you to submit a feature request. Describe the proposed feature, its benefits, and any potential implementation considerations.

  • Code Contributions: If you would like to contribute code to the HIP Subnet, please follow the guidelines below for submitting pull requests. We appreciate contributions that enhance the subnet's functionality, performance, or user experience.

  • Documentation: Help improve the HIP Subnet's documentation by fixing typos, clarifying explanations, or adding new sections. Good documentation is essential for users to understand and effectively utilize the subnet.

  • Testing: Assist in testing the HIP Subnet by running tests, verifying functionality, and providing feedback on the subnet's performance and reliability. Your testing efforts can help identify and address issues before they impact users.

Getting Started

To contribute to the HIP Subnet, follow these steps:

  • Fork the HIP Subnet repository on GitHub.

  • Clone your forked repository to your local machine: git clone https://github.com/your-username/HIP-Subnet.git

Create a new branch for your contribution: git checkout -b my-contribution

  • Make your changes or additions to the codebase.

  • Test your changes thoroughly to ensure they don't introduce new bugs.

  • Commit your changes with descriptive commit messages: git commit -m "Add new feature: ..."

Push your changes to your forked repository: git push origin my-contribution

Open a pull request on the main HIP Subnet repository, providing a clear description of your changes and their benefits. Your pull request will be reviewed by the maintainers, and any necessary feedback or changes will be discussed. Once your pull request is approved, it will be merged into the main branch of the HIP Subnet repository.

Code Guidelines

When contributing code to the HIP Subnet, please adhere to the following guidelines:

  • Follow the existing code style and conventions used in the subnet's codebase.

  • Write clear, concise, and well-documented code.

  • Use meaningful variable and function names that reflect their purpose.

  • Include appropriate error handling and logging.

  • Add tests to cover new functionality or modifications.

  • Ensure your code passes all existing tests and linting checks.

Communication

If you have any questions, concerns, or need clarification regarding your contribution, please feel free to reach out to the HIP Subnet maintainers or open an issue on the GitHub repository. We are here to assist you and appreciate your efforts to improve the subnet.

Thank you for your contribution to the HIP Subnet! Together, we can build a powerful human intelligence layer that benefits the entire Bittensor ecosystem.