Skip to content

Conversation

@Gimzou
Copy link
Contributor

@Gimzou Gimzou commented Sep 1, 2025

Description of the Change

Update several broken links in the contributing guidelines

This commit addresses multiple link issues in the contributing documentation to improve developer experience and ensure all references point to current, accessible resources.

Changes made:

Repository References:

  • Changed all repository references to use relative paths instead of full URLs (e.g., ../tests instead of https://github.com/opentensor/bittensor/tree/master/tests)
  • This makes the documentation more maintainable and prevents broken links when the repository structure changes

Discord Links:

  • Replaced temporary invitation links with the permanent Discord server address (https://discord.gg/bittensor)
  • Removed references to non-existing Discord channels (#bounties, #finney, #subnet-1-issues) that were causing confusion for new contributors

Documentation Updates:

Note: The configuration link provided in PR #3040 does not appear to point to the correct config.yml configuration documentation but rather to the Subnet configuration page.

SDK Version Reference:

  • Updated the Bittensor SDK version detection instructions to align with the current method documented in README.md

These changes ensure that contributors can successfully follow all links in the contributing guidelines and access the most up-to-date resources for Bittensor development.

Branch Acknowledgement

[x] I am acknowledging that I am opening this branch against staging

Update several broken links in the contributing guidelines:
- Fix documentation repository references
- Update Discord server and channel links
- Correct Bittensor documentation URLs

These fixes improve contributor experience by ensuring all
referenced resources are accessible.
Before making a PR for any code changes, please write adequate testing with unittest and/or pytest if it is warranted. This is **mandatory** for new features and enhancements. See the [testing guide](./TESTING.md) for more complete information.

You may also like to view the [/tests](https://github.com/opentensor/bittensor/tree/master/tests) for starter examples.
You may also like to view the [/tests](../tests) for starter examples.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link should remain the same. Only tests from the master branch can be considered stable for the publicly available latest version of bittensor.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ok, I’ll change the link back to the original one as soon as I’m back behind a computer

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, pls resolve the conflict

@Gimzou Gimzou requested a review from basfroman September 8, 2025 07:25
@basfroman basfroman added the documentation Improvements or additions to documentation label Sep 8, 2025
Copy link
Contributor

@MichaelTrestman MichaelTrestman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@basfroman basfroman merged commit c8711b2 into opentensor:staging Sep 9, 2025
448 checks passed
@ibraheem-abe ibraheem-abe mentioned this pull request Sep 25, 2025
basfroman added a commit that referenced this pull request Oct 14, 2025
…links

Fix broken links in CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants