docs: add community files and improve documentation #344
Conversation
- Add CONTRIBUTING.md with contribution guidelines - Add CODE_OF_CONDUCT.md (Contributor Covenant) - Update NOTICE.md copyright year (2022 → 2025) to match README - Add Contributing section to README with links to new files
📝 WalkthroughWalkthroughThis PR adds governance and contribution documentation to the repository. A new Code of Conduct document following the Contributor Covenant v2.0 is introduced, along with comprehensive Contributing guidelines for the Injective Protocol Go SDK. Project notices and README are updated to reflect these additions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 74-77: The CONTRIBUTING.md currently instructs contributors to
create a branch from `dev` using the example `git checkout -b
feature/your-feature-name`; update that instruction to use the repo's actual
base branch (replace `dev` with `master` or the correct default branch name) and
adjust the example branch command and any surrounding text to consistently
reference `master` (or the correct default) so contributors are directed to the
proper base branch.
- Around line 35-36: Update the Go prerequisite in CONTRIBUTING.md: replace the
string "Go 1.21 or later" with "Go 1.23 or later" so it matches the go directive
in go.mod (which currently reads "go 1.23.9"); leave other entries (e.g.,
"Make") unchanged.
| - Go 1.21 or later | ||
| - Make |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cat go.mod | grep -E '^go\s+'Repository: InjectiveLabs/sdk-go
Length of output: 73
Update Go version requirement to match go.mod.
The CONTRIBUTING.md states "Go 1.21 or later," but go.mod declares go 1.23.9. Update the prerequisite to "Go 1.23 or later" for accuracy.
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` around lines 35 - 36, Update the Go prerequisite in
CONTRIBUTING.md: replace the string "Go 1.21 or later" with "Go 1.23 or later"
so it matches the go directive in go.mod (which currently reads "go 1.23.9");
leave other entries (e.g., "Make") unchanged.
| 1. Create a new branch from `dev`: | ||
| ```bash | ||
| git checkout -b feature/your-feature-name | ||
| ``` |
There was a problem hiding this comment.
Branch base likely incorrect.
The guide says to branch from dev, but this repo appears to target master. This will misdirect contributors.
✅ Suggested fix
-1. Create a new branch from `dev`:
+1. Create a new branch from `master`:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Create a new branch from `dev`: | |
| ```bash | |
| git checkout -b feature/your-feature-name | |
| ``` | |
| 1. Create a new branch from `master`: |
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` around lines 74 - 77, The CONTRIBUTING.md currently
instructs contributors to create a branch from `dev` using the example `git
checkout -b feature/your-feature-name`; update that instruction to use the
repo's actual base branch (replace `dev` with `master` or the correct default
branch name) and adjust the example branch command and any surrounding text to
consistently reference `master` (or the correct default) so contributors are
directed to the proper base branch.
1 participant
Summary
This PR adds standard open source community files and updates documentation to improve the contributor experience.
Changes
CONTRIBUTING.mdCODE_OF_CONDUCT.mdNOTICE.mdREADME.mdWhy This Matters
Details
CONTRIBUTING.md includes:
make tests) and linter (make lint)CODE_OF_CONDUCT.md
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.