Skip to content

Correct the branch name and template placeholders in CONTRIBUTING.md - #279

Merged
dennisdoomen merged 1 commit into
dennisdoomen:mainfrom
ChrisonSimtian:fix/contributing-stale-placeholders
Oct 8, 2026
Merged

dennisdoomen merged 1 commit into
dennisdoomen:mainfrom
ChrisonSimtian:fix/contributing-stale-placeholders

Conversation

@ChrisonSimtian

Copy link
Copy Markdown
Contributor

Problem

CONTRIBUTING.md tells contributors to target the develop branch:

There is no develop branch in this repository, and there never has been. git for-each-ref finds no such ref, nothing in the history mentions one, and the last 12 merged pull requests all target main. agents.md already says the right thing:

Target branch: main (GitHub Flow — no separate develop branch)

So a new contributor who reads CONTRIBUTING.md first goes looking for a branch that is not there.

The same file still carries four placeholders from the template it was copied from. It was added in the first commit (1aff122, January 2025) and has not been edited since, so these have been there from the start:

  • https://github.com/yourname/yourrepo/issues in "Finding Existing Issues"
  • https://github.com/your-user-name/my-package/... in the bug report link
  • https://github.com/your-user-name/my-package/... in the API proposal link
  • * TODO: any other guidelines you want people to follow in the DOs and DON'Ts list

Change

  • develop becomes main.
  • The three links point at this repository.
  • The TODO item is removed.

Documentation only. Nothing else in the file is touched, so the API approval process and the rest of the guidelines read as before.

Tests

None. No code changed. I followed both links to the issue templates and they open the correct forms.

While checking this I noticed the labels the issue forms ask for (api-suggestion, feature, triage) and the api-approved label that CONTRIBUTING.md mentions do not exist in the repository, so GitHub drops them when an issue is created. I left that alone, since deciding whether to create those labels or change the text is your call, not a typo fix. Happy to follow up if you want it.

🤖 Generated with Claude Code

https://claude.ai/code/session_01TK6dHqkZwhjWUrZNnnb8MG

The file tells contributors to target `develop`. That branch does not exist
and never has. agents.md says `main`, and that matches every merged pull
request.

The file also still carries four placeholders from the template it was copied
from: three links pointing at `yourname/yourrepo` and `your-user-name/my-package`,
and an unfinished `TODO` item in the DOs and DON'Ts list.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TK6dHqkZwhjWUrZNnnb8MG
@dennisdoomen dennisdoomen added the documentation Improvements or additions to documentation label Oct 8, 2026
@dennisdoomen
dennisdoomen merged commit 3dbf099 into dennisdoomen:main Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants