diff --git a/contrib/CONTRIBUTING.md b/contrib/CONTRIBUTING.md index f9f4ed5f34..b27b426a09 100644 --- a/contrib/CONTRIBUTING.md +++ b/contrib/CONTRIBUTING.md @@ -35,7 +35,7 @@ Bittensor is still in the Alpha stages, and as such you will likely run into som Additionally, note that the core implementation of Bittensor consists of two separate repositories: [The core Bittensor code](https://github.com/opentensor/bittensor) and the Bittensor Blockchain [subtensor](https://github.com/opentensor/subtensor). -Supplemental repository for the Bittensor subnet template can be found [here](https://github.com/opentensor/bittensor-subnet-template). This is a great first place to look for getting your hands dirty and started learning and building on Bittensor. See the subnet links [page](https://github.com/opentensor/bittensor-subnet-template/blob/main/subnet_links.json) for a list of all the repositories for the active registered subnets. +Supplemental repository for the Bittensor subnet template can be found [here](https://github.com/opentensor/bittensor-subnet-template). This is a great first place to look for getting your hands dirty and start learning and building on Bittensor. See the subnet links [page](https://github.com/opentensor/bittensor-subnet-template/blob/main/subnet_links.json) for a list of all the repositories for the active registered subnets. ## Getting Started New contributors are very welcome and needed. @@ -43,7 +43,7 @@ Reviewing and testing is highly valued and the most effective way you can contri Before you start contributing, familiarize yourself with the Bittensor Core build system and tests. Refer to the documentation in the repository on how to build Bittensor core and how to run the unit tests, functional tests. -There are many open issues of varying difficulty waiting to be fixed. If you're looking for somewhere to start contributing, check out the [good first issue](https://github.com/opentensor/bittensor/labels/good%20first%20issue) list or changes that are up for grabs. Some of them might no longer be applicable. So if you are interested, but unsure, you might want to leave a comment on the issue first. Also peruse the [issues](https://github.com/opentensor/bittensor/issues) tab for all open issues. +There are many open issues of varying difficulty waiting to be fixed. If you're looking for somewhere to start contributing, check out the [good first issue](https://github.com/opentensor/bittensor/labels/good%20first%20issue) list or changes that are up for grabs. Some of them might no longer be applicable. So if you are interested, but unsure, you might want to leave a comment on the issue first. Also peruse the [issues](https://github.com/opentensor/bittensor/issues) tab for all open issues. ### Good First Issue Label The purpose of the good first issue label is to highlight which issues are suitable for a new contributor without a deep understanding of the codebase. @@ -264,7 +264,7 @@ Provide more context by answering these questions: Include details about your configuration and environment: -* **Which version of Bittensor are you using?** You can get the version by checking for `__version__` in [`bittensor/bittensor/__init.py`](https://github.com/opentensor/bittensor/blob/master/bittensor/__init__.py#L30). This is not sufficient. Also add the commit hash of the branch you are on. +* **Which version of Bittensor are you using?** You can get the version by checking for `__version__` in [`bittensor/bittensor/__init.py`](https://github.com/opentensor/bittensor/blob/master/bittensor/__init__.py#L30). This is not sufficient. Also add the commit hash of the branch you are on. * **What commit hash are you on?** You can get the exact commit hash by checking `git log` and pasting the full commit hash. * **What's the name and version of the OS you're using**? * **Are you running Bittensor in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest? @@ -282,7 +282,7 @@ When you are creating an enhancement suggestion, please [include as many details * **Check the [debugging guide](./DEBUGGING.md).** for tips — you might discover that the enhancement is already available. Most importantly, check if you're using the latest version of Bittensor by pulling the latest changes from the Master branch and if you can get the desired behavior by changing [Bittensor's config settings](https://opentensor.github.io/getting-started/configuration.html). * **Determine which repository the problem should be reported in: if it has to do with your ML model, then it's likely [Bittensor](https://github.com/opentensor/bittensor). If you are having problems with your emissions or Blockchain, then it is in [subtensor](https://github.com/opentensor/subtensor) -#### How Submit A (Good) Feature Suggestion +#### How To Submit A (Good) Feature Suggestion Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined which repository ([Bittensor](https://github.com/opentensor/bittensor) or [subtensor](https://github.com/opentensor/subtensor)) your enhancement suggestion is related to, create an issue on that repository and provide the following information: diff --git a/contrib/DEBUGGING.md b/contrib/DEBUGGING.md index 093e3432bf..22013abcb8 100644 --- a/contrib/DEBUGGING.md +++ b/contrib/DEBUGGING.md @@ -135,7 +135,7 @@ import pdb; pdb.set_trace() # breakpoint! This will stop execution at the breakpoint you set and can operate on the stack directly in the terminal. ## Searching for strings -Use `ag`. It's fast, convenient, and widely available on unix systems. Ag will highlight all occurnaces of a given pattern. +Use `ag`. It's fast, convenient, and widely available on unix systems. Ag will highlight all occurrences of a given pattern. ```bash apt-get install silversearcher-ag diff --git a/contrib/RELEASE_GUIDELINES.md b/contrib/RELEASE_GUIDELINES.md index d6bda7c860..74658624d8 100644 --- a/contrib/RELEASE_GUIDELINES.md +++ b/contrib/RELEASE_GUIDELINES.md @@ -30,12 +30,12 @@ If you are new in this role, ask for the proper setup you need to run this proce Options: - -U, --update: type of update. It could be major, minor, patch or rc (release candidate). - - -A, --apply: This specify to apply the release. Without this the versioning will just show a dry run with no changes. + - -A, --apply: This specifies to apply the release. Without this the versioning will just show a dry run with no changes. ## Release script usage Options: - - -A, --apply: This specify to apply the release. Without this the release will just show a dry run with no changes. + - -A, --apply: This specifies to apply the release. Without this the release will just show a dry run with no changes. - -T,--github-token: A github personal access token to interact with the Github API. ### Github token @@ -84,4 +84,4 @@ After a Bittensor release we have to 1. Updating the [Dockerfile](https://github.com/opentensor/cubit/blob/master/docker/Dockerfile) 1. Building its docker image (follow its README instructions) 1. Push it to hub.docker.com - 1. The generated name will be the same but with `-cubit` in its name \ No newline at end of file + 1. The generated name will be the same but with `-cubit` in its name diff --git a/contrib/STYLE.md b/contrib/STYLE.md index 7804359d22..13558ac9e4 100644 --- a/contrib/STYLE.md +++ b/contrib/STYLE.md @@ -58,7 +58,7 @@ Python's official style guide is PEP 8, which provides conventions for writing c #### More details -Use [`ruff` to format](https://docs.astral.sh/ruff/formatter/#the-ruff-formatter) your python code before commiting for consistency across such a large pool of contributors. +Use [`ruff` to format](https://docs.astral.sh/ruff/formatter/#the-ruff-formatter) your python code before committing for consistency across such a large pool of contributors. Black code [style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#code-style) ensures consistent and opinionated code formatting. Ruff automatically formats your Python code according to the Black style guide, enhancing code readability and maintainability. @@ -155,7 +155,7 @@ For example: Fix typo in introduction to user guide -Nothing more need be said; if the reader wonders what the typo was, she can simply take a look at the change itself, i.e. use git show or git diff or git log -p. +Nothing more needs to be said; if the reader wonders what the typo was, she can simply take a look at the change itself, i.e. use git show or git diff or git log -p. If you’re committing something like this at the command line, it’s easy to use the -m option to git commit: @@ -197,7 +197,7 @@ Imperative mood just means “spoken or written as if giving a command or instru Close the door Take out the trash -Each of the seven rules you’re reading about right now are written in the imperative (“Wrap the body at 72 characters”, etc.). +Each of the seven rules you’re reading about right now is written in the imperative (“Wrap the body at 72 characters”, etc.). The imperative can sound a little rude; that’s why we don’t often use it. But it’s perfect for Git commit subject lines. One reason for this is that Git itself uses the imperative whenever it creates a commit on your behalf.