-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6a8dd57
commit 6827ec1
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Contributing to Bittensor CLI | ||
| We want to make contributing to this project as easy and transparent as | ||
| possible. | ||
|
|
||
| We have an official Discord server where the community chimes in with helpful advice if you have questions. | ||
| This is the fastest way to get an answer and the core development team is active on Discord. | ||
|
|
||
| * [Official Bittensor Discord](https://discord.gg/7wvFuPJZgq) | ||
| * [Bittensor Developers Group (Church of Rao)](https://discord.gg/4AMrc7B4) | ||
|
|
||
| ## Issues | ||
| We use GitHub issues to track bugs and improvements. Please ensure your description is | ||
| clear and has sufficient instructions to be able to reproduce the issue. | ||
|
|
||
| When submitting a bug report, please include the following information: | ||
| 1. Python version | ||
| 2. Network or Chain which was being used to interact with Subtensor | ||
| 3. Steps to reproduce the issue | ||
| 4. Expected behavior and actual behavior | ||
| 5. Any error messages or stack traces encountered | ||
|
|
||
| ## Pull Requests | ||
| We welcome your pull requests. To ensure a smooth and efficient review process, please follow these guidelines: | ||
|
|
||
| ### Bug fixes & Improvements: | ||
|
|
||
| 1. Fork the repo and create your branch from `staging`. | ||
| 2. If you've added code that should be tested, add tests. | ||
| 3. If you've changed APIs, update the documentation. | ||
| 4. Ensure the test suite passes. | ||
| 5. Make sure your code lints. We use ruff for linting. | ||
| 6. Provide detailed explanation what your PR fixes, alternate designs, and possible ripple effects. | ||
|
|
||
| ### Feature Requests | ||
| We welcome feature requests and suggestions for improving the Bittensor CLI. To submit a feature request, please follow these guidelines: | ||
|
|
||
| 1. If your feature request doesn't already exist, create a new issue on GitHub with the label "enhancement" or "feature request". | ||
| 3. Provide a clear and descriptive title for the feature request. | ||
| 4. Explain the feature you'd like to see added, why it would be useful, and how it could be implemented. Be as specific as possible. | ||
| 5. If applicable, include examples, screenshots, or mockups to help illustrate your feature request. | ||
| 6. Be patient and understanding. The maintainers will review your feature request and provide feedback. |