Skip to content

docs: add missing devguide.md + process.md#79

Merged
Skarlso merged 2 commits into
external-secrets:mainfrom
dangbert:dev-guide
Apr 28, 2026
Merged

docs: add missing devguide.md + process.md#79
Skarlso merged 2 commits into
external-secrets:mainfrom
dangbert:dev-guide

Conversation

@dangbert

@dangbert dangbert commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

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

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage (N/A)
  • All tests pass with make test (make test-ci)
  • I ensured my PR is ready for review with make reviewable (this doesn't exist)

Documentation additions and gitignore update

This PR adds developer and contribution process documentation and updates ignore patterns.

Files added/changed:

  • docs/contributing/devguide.md — Local development instructions: Go install, dependency setup (go mod tidy), server startup (go run main.go serve --insecure --hostname :9998 --debug), optional Delve debug workflow, and test commands (make test-ci; macOS go test variant).
  • docs/contributing/process.md — Contribution/process guidance: issue filing, labels, PR workflow, merge checklist, and rule requiring two approvers for PRs labeled size/l and larger.
  • .github/pull_request_template.md — Updates PR checklist to require running tests with make test-ci and removes the make reviewable item.
  • .gitignore — Adds pattern to ignore Delve debug files (_debug*).

All changes are documentation/configuration only and do not affect public APIs or exported entities.

@coderabbitai

coderabbitai Bot commented Apr 22, 2026

Copy link
Copy Markdown

Walkthrough

Adds developer-facing documentation for local Go development and contribution process, updates the pull request template test command, and updates .gitignore to ignore Delve debug files named with the __debug_* pattern.

Changes

Cohort / File(s) Summary
Git Configuration
\.gitignore
Adds rule to ignore Delve debug output files matching the __debug_* pattern.
Developer Guides
docs/contributing/devguide.md
Adds a Local Setup section with Go setup, go mod tidy, running the server (go run main.go serve ...), optional Delve debugging steps (pinned dlv version, dlv debug usage, breakpoint/continue example), and a Unit Tests section with make test-ci and macOS-specific go test invocation.
Contribution Process
docs/contributing/process.md
Adds contribution workflow: file issues in GitHub, claim/assign guidance, PR fork/branch process, merge checklist, reviewer/approval rules, and requirement for >=2 approvers on PRs labeled _size/l_ and above.
PR Template
.github/pull_request_template.md
Updates checklist to require make test-ci instead of make test and removes the make reviewable checklist item.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR addresses issue #78 by restoring the missing devguide.md and process.md files with comprehensive documentation for local setup, testing, and contribution workflows.
Out of Scope Changes check ✅ Passed All changes are directly aligned with the linked issue objectives: adding missing documentation files, updating .gitignore for debugging, and updating the PR template checklist.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@dangbert

dangbert commented Apr 22, 2026

Copy link
Copy Markdown
Contributor Author

I will signoff my commits later and revisit, let me know if the md files are agreeable though!

@dangbert
dangbert marked this pull request as ready for review April 24, 2026 10:15

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 37759d4 and 83070ad.

📒 Files selected for processing (3)
  • .gitignore
  • docs/contributing/devguide.md
  • docs/contributing/process.md

Comment thread docs/contributing/devguide.md Outdated
Comment thread docs/contributing/process.md
@dangbert

dangbert commented Apr 24, 2026

Copy link
Copy Markdown
Contributor Author

Note the PR template included some inexistant Makefile commands, I've proposed a change in c4ff7d9

This PR is good to go from my end 🤝

@Skarlso Skarlso left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! :) Thanks, good job! :)

@Skarlso

Skarlso commented Apr 24, 2026

Copy link
Copy Markdown
Collaborator

@dangbert could you please update your commits to have proper signatures? :)

@Skarlso

Skarlso commented Apr 25, 2026

Copy link
Copy Markdown
Collaborator

@dangbert you need sign your commits, then I can merge them. :)

dangbert and others added 2 commits April 28, 2026 03:22
Signed-off-by: Daniel Engbert <end1@umbc.edu>
Signed-off-by: Daniel Engbert <end1@umbc.edu>
@dangbert

Copy link
Copy Markdown
Contributor Author

done!

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (1)
docs/contributing/process.md (1)

2-3: ⚠️ Potential issue | 🟡 Minor

Fix 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:1 only 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

📥 Commits

Reviewing files that changed from the base of the PR and between 83070ad and a74581e.

📒 Files selected for processing (4)
  • .github/pull_request_template.md
  • .gitignore
  • docs/contributing/devguide.md
  • docs/contributing/process.md
✅ Files skipped from review due to trivial changes (3)
  • .gitignore
  • .github/pull_request_template.md
  • docs/contributing/devguide.md

@Skarlso
Skarlso merged commit 21baed1 into external-secrets:main Apr 28, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

broken links in docs (developer guide)

2 participants