chore: create CONTRIBUTING.md #224
Conversation
Signed-off-by: Joao Luna <[email protected]>
WalkthroughA new Changes
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
CONTRIBUTING.md (5)
37-41: Standardise bullet list marker (-instead of*)Lines 38-40 mix
*with earlier-, triggering MD004 and making the list style inconsistent. Use a single marker throughout the doc:-* Report issues at the Akash support repo, tagged with repo/akash-api. -* All PRs must reference an open issue in the support repo. -* Label issues suitable for new contributors as good first issue or ready-for-community-dev. +- Report issues in the Akash support repo, tagged `repo/akash-api`. +- All PRs must reference an open issue in the support repo. +- Label issues suitable for new contributors as **good first issue** or **ready-for-community-dev**.
46-55: Fix mixed bullet style & improve Go-centric wordingSame MD004 problem plus a minor clarity tweak (“don’t ignore them” ➜ “do not ignore them”):
-* Use `go fmt` on all Go code. -* Maintain idiomatic Go naming conventions (CamelCase, explicit error checks). -* Adhere to the principles of clean code. +- Use `go fmt ./...` on all Go code. +- Maintain idiomatic Go naming conventions (CamelCase, explicit error checks). +- Adhere to clean-code principles. @@ -* Handle errors explicitly, don’t ignore them. -* Document exported types/functions with GoDoc comments. -* Document complex unexported functions. +- Handle errors explicitly; **do not ignore them**. +- Document exported types/functions with GoDoc comments. +- Document complex unexported functions.
57-63: Add language tag & remove tab indentation for proto-generation block-* After editing .proto, run: - ``` - make proto-gen - ``` +* After editing `.proto` files, run: + ```bash + make proto-gen + ```This clears MD010/MD040 and keeps indentation consistent.
74-79: Final lint tidy-up for Testing & CI listConsistent dash bullets and small copy edit (“must” ➜ “should” for softer tone):
-* Tests should cover your changes—place them in `_test.go` files. -* All CI checks (format, lint, proto-gen, tests) must pass before merging. -* The CI pipeline runs workflows on pushes and PRs using GitHub Actions. +- Tests should cover your changes and live in `_test.go` files. +- All CI checks (format, lint, proto-gen, tests) must pass before merging. +- The CI pipeline runs GitHub Actions workflows on pushes and pull requests.
90-100: Optional: make the LICENSE link absoluteTo avoid broken links when the markdown is viewed outside GitHub (e.g., package registries), consider an absolute link:
-By contributing, you agree that your contributions will be licensed under the project's [Apache 2.0 License](LICENSE). +By contributing, you agree that your work is licensed under the project’s [Apache 2.0 License](https://github.com/akash-network/akash-api/blob/main/LICENSE).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
22-22: Hard tabs
Column: 4
(MD010, no-hard-tabs)
23-23: Hard tabs
Column: 4
(MD010, no-hard-tabs)
24-24: Hard tabs
Column: 4
(MD010, no-hard-tabs)
25-25: Hard tabs
Column: 1
(MD010, no-hard-tabs)
28-28: Hard tabs
Column: 1
(MD010, no-hard-tabs)
28-28: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
29-29: Hard tabs
Column: 1
(MD010, no-hard-tabs)
30-30: Hard tabs
Column: 1
(MD010, no-hard-tabs)
32-32: Hard tabs
Column: 1
(MD010, no-hard-tabs)
32-32: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
33-33: Hard tabs
Column: 1
(MD010, no-hard-tabs)
34-34: Hard tabs
Column: 1
(MD010, no-hard-tabs)
38-38: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
39-39: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
40-40: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
47-47: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
48-48: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
49-49: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
52-52: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
53-53: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
54-54: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
57-57: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
58-58: Hard tabs
Column: 1
(MD010, no-hard-tabs)
58-58: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
59-59: Hard tabs
Column: 1
(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
65-65: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
69-69: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
76-76: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
77-77: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
78-78: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
84-84: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: test
- GitHub Check: coverage
- GitHub Check: go
CONTRIBUTING.md
Outdated
| - **Go** ≥ 1.21 | ||
| - **GNU Make** ≥ 4.0 | ||
| - **Bash** ≥ 4.0 | ||
| - **Protocol Buffer tools** (e.g., `buf`, `protoc`) |
There was a problem hiding this comment.
no need for this. proto tools are being installed into local cache.
instead direnv is required.
There was a problem hiding this comment.
lets also add OS specific installation instructions with all tools listed
There was a problem hiding this comment.
Does it make sense for OS specific installations on Akash API? I'm currently on MacOS and don't recall having issues with the installation on Linux as well?
Signed-off-by: Joao Luna <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
CONTRIBUTING.md (1)
61-63: Same tab / language issue in the proto-gen reminder- ``` - make proto-gen - ``` + ```bash + make proto-gen + ```
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
25-30: Use correct branding (“macOS”) and add Linux instructions for parity
MacOSshould be spelledmacOSper Apple’s branding guidelines.
While you provide Homebrew steps, there’s no equivalent for mainstream Linux distros, leaving most contributors guessing.- - **MacOS** - ```shell - brew install direnv - ``` + - **macOS** + ```bash + brew install direnv + ``` + - **Ubuntu / Debian** + ```bash + sudo apt-get update && sudo apt-get install direnv + ```
35-37: Remove hard-tabs & specify language to silence markdownlint (MD010, MD040)Tabs are still present and the fenced block lacks a language identifier:
- ``` - make proto-gen - ``` + ```bash + make proto-gen + ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[grammar] ~26-~26: The operating system from Apple is written “macOS”.
Context: ...ps://direnv.net/docs/hook.html) - MacOS ```shell brew install direnv ...
(MAC_OS)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
35-35: Hard tabs
Column: 1
(MD010, no-hard-tabs)
35-35: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
36-36: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
41-41: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
42-42: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
43-43: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
50-50: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
51-51: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
52-52: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
55-55: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
56-56: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
57-57: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
60-60: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
61-61: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
62-62: Hard tabs
Column: 1
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 1
(MD010, no-hard-tabs)
64-64: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
68-68: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
72-72: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
79-79: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
80-80: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
81-81: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
87-87: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: coverage
- GitHub Check: test
- GitHub Check: go
🔇 Additional comments (1)
CONTRIBUTING.md (1)
13-16: Verify Go 1.24 requirementGo 1.24 has not been released yet; requiring it may unnecessarily block contributors.
Consider “Go ≥ 1.22 (latest stable)” or similar, or clarify why 1.24 is mandatory.
Signed-off-by: Joao Luna <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
CONTRIBUTING.md (2)
35-37: Remove hard-tabs & addbashlanguage tag to fix markdownlint MD010/MD040The block still contains a tab byte and has no language, so
markdownlintwill fail CI the same way as the earlier snippet that was already flagged.- ``` - make proto-gen - ``` + ```bash + make proto-gen + ```
61-63: Same issue: hard-tabs + missing language in the secondproto-gensnippet- ``` - make proto-gen - ``` + ```bash + make proto-gen + ```
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
26-27: Use correct branding – “macOS”, not “MacOS”.Apple’s OS is stylised as “macOS”.
Update the heading to avoid a spelling nit picked up by LanguageTool.
41-44: Unify list markers for readability & MD004 complianceThe rest of the document uses “-” list markers; switch these three “*” items to dashes to keep a consistent style and silence
markdownlintMD004.-* Report issues at the Akash support repo, tagged with repo/akash-api. -* All PRs must reference an open issue in the support repo. -* Label issues suitable for new contributors as good first issue or ready-for-community-dev. +- Report issues at the Akash support repo, tagged with repo/akash-api. +- All PRs must reference an open issue in the support repo. +- Label issues suitable for new contributors as good first issue or ready-for-community-dev.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[grammar] ~26-~26: The operating system from Apple is written “macOS”.
Context: ...ps://direnv.net/docs/hook.html) - MacOS ```shell brew install go git ...
(MAC_OS)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
35-35: Hard tabs
Column: 1
(MD010, no-hard-tabs)
35-35: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
36-36: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
41-41: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
42-42: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
43-43: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
50-50: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
51-51: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
52-52: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
55-55: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
56-56: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
57-57: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
60-60: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
61-61: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
62-62: Hard tabs
Column: 1
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 1
(MD010, no-hard-tabs)
64-64: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
68-68: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
72-72: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
79-79: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
80-80: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
81-81: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
87-87: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: test
- GitHub Check: coverage
- GitHub Check: proto
- GitHub Check: go
🌟 PR Title
chore: create CONTRIBUTING.md
📝 Description
Introduce
CONTRIBUTING.mdto theakash-apirepository.🔧 Purpose of the Change
✅ Checklist
📎 Notes for Reviewers
[Include any additional context, architectural decisions, or specific areas to focus on]
Summary by CodeRabbit