From a60de40fadade65ed0cf2dd2db8f819fd3119450 Mon Sep 17 00:00:00 2001 From: HappyG1lmore Date: Wed, 13 May 2026 00:38:13 +0300 Subject: [PATCH 1/2] docs: fix contributing links --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85de745..9136bf6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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 From 806e9d4b87145980955dc9c895167b2801eeec5c Mon Sep 17 00:00:00 2001 From: HappyG1lmore Date: Wed, 13 May 2026 00:55:19 +0300 Subject: [PATCH 2/2] docs: align contributing branch guidance --- CONTRIBUTING.md | 5 ++--- README.md | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9136bf6..b4ded1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 8f74953..8622fa0 100644 --- a/README.md +++ b/README.md @@ -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)