Skip to content

Click-specific contribution guidelines#3333

Open
kdeldycke wants to merge 1 commit intopallets:stablefrom
kdeldycke:contributing-rules
Open

Click-specific contribution guidelines#3333
kdeldycke wants to merge 1 commit intopallets:stablefrom
kdeldycke:contributing-rules

Conversation

@kdeldycke
Copy link
Copy Markdown
Collaborator

Here is the list of contribution guidelines I accumulated over the past year based on feedbacks from the community.

My plan is to:

  • collect feedback on them to refine/expand them
  • decides which should be scoped as Click-specific
  • decides on which should be contributed back to the Pallets umbrella at https://github.com/pallets/.github/blob/main/CONTRIBUTING.md
  • look into the current state of stable before 8.3.3 release and applies them thoroughly

This PR is a follow-up on #3151 , which inaugurated the creation of Click-specific docs/contributing.md document. I will rebase this PR once the later is merged.

@kdeldycke kdeldycke added the docs label Apr 11, 2026
@kdeldycke kdeldycke added this to the 8.3.3 milestone Apr 11, 2026
@kdeldycke kdeldycke changed the title Compile Click-specific guidelines Click-specific contribution guidelines Apr 11, 2026
kdeldycke referenced this pull request Apr 11, 2026
Add missing entries for #3238 and #3299
Fix wrong version for #3245 changelog entry
Lint section format
@davidism
Copy link
Copy Markdown
Member

davidism commented Apr 11, 2026

Check out https://palletsprojects.com/contributing/ first. Most of this either is mentioned there, or should be expanded there.

For example, the changelog is already mentioned in https://palletsprojects.com/contributing/pr

Also, for docs, I'm sorry I keep harping on this, but it's not that GitHub links don't belong in docs but in comments. It's that the links should not be anywhere. The docs and comments must stand on their own. Do not include GitHub issue/pr numbers or links. The only place issues or PRs should be linked or mentioned is in the changelog page. This applies to Click issues/prs, you can still add links to cpython or other projects, if the code is working around a reported issue in something else.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants