Skip to content

docs: fix contributing links and branch guidance#398

Open
HappyG1lmore wants to merge 1 commit into
canopy-network:mainfrom
HappyG1lmore:docs/fix-contributing-links
Open

docs: fix contributing links and branch guidance#398
HappyG1lmore wants to merge 1 commit into
canopy-network:mainfrom
HappyG1lmore:docs/fix-contributing-links

Conversation

@HappyG1lmore
Copy link
Copy Markdown

Description

Fix stale and placeholder links in the contribution docs, and align branch guidance with the repository's default branch.

Changes Made

  • Replace the TODO documentation link with the official Canopy docs URL
  • Replace the placeholder Discord link with the active invite already used elsewhere in the docs
  • Update README and CONTRIBUTING branch guidance from development to main

Testing

  • Documentation-only change
  • Verified the repository default branch is main
  • Verified the development branch is not present via GitHub API

Comment thread CONTRIBUTING.md
- Example: `// Transaction represents a single blockchain transaction.`

- **Branch Strategy**: All pull requests should be:
- Based on the `development` branch
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

the development branch information is incorrect, merges should be done against the main branch at the moment, the actual code intended to be used in validators are the versioned releases but we do expect PR's to be merged againstmain

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Thanks for clarifying. The current PR diff updates the branch guidance to target main only. I left the versioned-release validator note out of CONTRIBUTING to keep this patch focused, but can add that nuance if you want it documented there too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants