Skip to content

docs: fix contributing links #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HappyG1lmore wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix contributing links #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a60de40
docs: fix contributing links
HappyG1lmore May 12, 2026
806e9d4
docs: align contributing branch guidance
HappyG1lmore May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ We always appreciate a well-written, thorough bug report. :v:
In short, since you are most likely a developer, **provide a ticket that you would like to
receive**.

- **Review the [documentation](TODO) before opening a new issue.
- **Review the [documentation](https://canopy-network.gitbook.io/docs) before opening a new issue.**

- **Do not open a duplicate issue.** Search through existing issues to see if your issue has
previously been reported. If your issue exists, comment with any additional information you have.
Expand Down Expand Up @@ -62,7 +62,7 @@ discuss your intended approach for solving the problem in the comments for an ex

- **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a
strategy with the maintainers. Or better yet, contact us directly on our
[Discord](https://discord.gg/your-discord-link). Otherwise, you risk doing a lot of work for
[Discord](https://discord.gg/pNcSJj7Wdh). Otherwise, you risk doing a lot of work for
nothing!

- **Prioritize understanding over cleverness.** Write code clearly and concisely. Remember that
Expand Down Expand Up @@ -121,9 +121,8 @@ Key requirements:
- Example: `// Transaction represents a single blockchain transaction.`

- **Branch Strategy**: All pull requests should be:
- Based on the `development` branch
- Opened against the `development` branch
- Merged into `development` first before being promoted to `main`
- Based on the `main` branch
- Opened against the `main` branch

- **EditorConfig Support**: We recommend using EditorConfig to maintain consistent coding styles.
The project includes an `.editorconfig` file that defines common formatting rules.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ make test
- Code must adhere to official Go formatting (use [`gofmt`](https://golang.org/cmd/gofmt)).
- (Optional) Use [EditorConfig](https://editorconfig.org) for consistent formatting.
- All code should follow Go documentation/commentary guidelines.
- PRs should be opened against the `development` branch.
- PRs should be opened against the `main` branch.

[![Pre-Release](https://img.shields.io/github/release-pre/canopy-network/canopy.svg)](https://github.com/canopy-network/canopy/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/canopy-network/canopy)](https://goreportcard.com/report/github.com/canopy-network/canopy)
Expand Down