docs: add missing devguide.md + process.md#79
Conversation
WalkthroughAdds developer-facing documentation for local Go development and contribution process, updates the pull request template test command, and updates Changes
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 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 |
|
I will signoff my commits later and revisit, let me know if the md files are agreeable though! |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/contributing/devguide.md`:
- Line 16: The startup example in the docs uses the wrong CLI subcommand name
("server") — update the example in docs/contributing/devguide.md to use the
actual subcommand "serve" used by the CLI (the command defined on the rootCmd),
i.e., change the example invocation to "go run main.go serve --insecure
--hostname :9998 --debug".
In `@docs/contributing/process.md`:
- Around line 2-3: Fix wording and grammar for consistency: change the sentence
"The Code, our TODOs and Documentation is maintained on [GitHub]..." to "The
code, our TODOs, and documentation are maintained on GitHub." Ensure parallel
punctuation (commas) around the list, use lowercase for "code" and
"documentation" for style consistency, and correct the verb agreement to "are
maintained." Also normalize spelling across the file to a single variant
(replace all occurrences of "labelled" with "labeled") and tighten the phrasing
at the other flagged spots (revise line 26 for parallel structure and concision
and adjust line 35 to use the chosen "labeled" spelling).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 347c28a3-063a-40b7-a991-4477f1642eff
📒 Files selected for processing (3)
.gitignoredocs/contributing/devguide.mddocs/contributing/process.md
|
Note the PR template included some inexistant This PR is good to go from my end 🤝 |
Skarlso
left a comment
There was a problem hiding this comment.
Nice! :) Thanks, good job! :)
|
@dangbert could you please update your commits to have proper signatures? :) |
|
@dangbert you need sign your commits, then I can merge them. :) |
Signed-off-by: Daniel Engbert <end1@umbc.edu>
Signed-off-by: Daniel Engbert <end1@umbc.edu>
|
done! |
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/contributing/process.md (1)
2-3:⚠️ Potential issue | 🟡 MinorFix wording/grammar consistency in contributor guidance (still unresolved).
Line 2 and Line 26 have grammar errors, and Line 35 mixes spelling variants with earlier text. Please normalize these in one pass.
Proposed edit
-The Code, our TODOs and Documentation is maintained on +The code, our TODOs, and documentation are maintained on [GitHub](https://github.com/external-secrets/bitwarden-sdk-server). All Issues should be opened in that repository. @@ -* PR needs be reviewed and approved +* PR needs to be reviewed and approved @@ -Pull requests that are labelled with _size/l_ and above _MUST_ have at least **TWO** +Pull requests that are labeled with _size/l_ and above _MUST_ have at least **TWO** approvers for it to be merged. Please respect this policy to ensure the quality of code in this project.Also applies to: 26-26, 35-35
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/contributing/process.md` around lines 2 - 3, Update the opening sentence "The Code, our TODOs and Documentation is maintained on" to correct grammar and casing — change it to "The code, our TODOs, and documentation are maintained on GitHub" and ensure the GitHub link remains intact; then scan the document for inconsistent spelling variants (e.g., initialise/initialize, organisation/organization) and normalize all to a single variant (pick American English or British English consistently), and remove inconsistent mid-sentence title-casing like "Code" or "Documentation" so phrasing and spelling are consistent throughout (also apply the same fixes to the later occurrences referenced by the reviewer, e.g. the other sentences showing variant spelling).
🧹 Nitpick comments (1)
docs/contributing/process.md (1)
35-37: Clarify whether the “two approvers for size/l+” rule is enforced or policy-only.Given
.github/CODEOWNERS:1only defines ownership, this requirement may read as automatically enforced when it might be a maintainer policy. Consider adding one short line stating where it is enforced (e.g., branch protection/ruleset or manual maintainer check).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/contributing/process.md` around lines 35 - 37, The sentence "Pull requests that are labelled with _size/l_ and above _MUST_ have at least **TWO** approvers" is ambiguous about whether it's automatically enforced; update the same paragraph to add one short clarifying line stating how the rule is enforced (e.g., "This is enforced via GitHub branch protection rules" or "This is a maintainer policy enforced during reviews"), and if automated, reference the enforcement mechanism (branch protection/ruleset) so readers know where to look or whom to contact.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/contributing/process.md`:
- Around line 2-3: Update the opening sentence "The Code, our TODOs and
Documentation is maintained on" to correct grammar and casing — change it to
"The code, our TODOs, and documentation are maintained on GitHub" and ensure the
GitHub link remains intact; then scan the document for inconsistent spelling
variants (e.g., initialise/initialize, organisation/organization) and normalize
all to a single variant (pick American English or British English consistently),
and remove inconsistent mid-sentence title-casing like "Code" or "Documentation"
so phrasing and spelling are consistent throughout (also apply the same fixes to
the later occurrences referenced by the reviewer, e.g. the other sentences
showing variant spelling).
---
Nitpick comments:
In `@docs/contributing/process.md`:
- Around line 35-37: The sentence "Pull requests that are labelled with _size/l_
and above _MUST_ have at least **TWO** approvers" is ambiguous about whether
it's automatically enforced; update the same paragraph to add one short
clarifying line stating how the rule is enforced (e.g., "This is enforced via
GitHub branch protection rules" or "This is a maintainer policy enforced during
reviews"), and if automated, reference the enforcement mechanism (branch
protection/ruleset) so readers know where to look or whom to contact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b3694d5d-57c8-48b8-96e3-24d777f7d602
📒 Files selected for processing (4)
.github/pull_request_template.md.gitignoredocs/contributing/devguide.mddocs/contributing/process.md
✅ Files skipped from review due to trivial changes (3)
- .gitignore
- .github/pull_request_template.md
- docs/contributing/devguide.md
Problem Statement
Improve docs, fixing broken links.
Related Issue
Fixes #78
Proposed Changes
I copied part of the process.md from the external-secrets/external-secrets repo
Checklist
git commit --signoffmake test(make test-ci)I ensured my PR is ready for review with(this doesn't exist)make reviewableDocumentation additions and gitignore update
This PR adds developer and contribution process documentation and updates ignore patterns.
Files added/changed:
All changes are documentation/configuration only and do not affect public APIs or exported entities.