Skip to content

Add default PR template and CONTRIBUTING - #17

Open
reardonj wants to merge 1 commit into
typelevel:mainfrom
reardonj:contributing-guidelines
Open

Add default PR template and CONTRIBUTING#17
reardonj wants to merge 1 commit into
typelevel:mainfrom
reardonj:contributing-guidelines

Conversation

@reardonj

@reardonj reardonj commented Sep 2, 2026

Copy link
Copy Markdown

Adds a new PR template to remind contributors about PR expectations, and a default minimal CONTRIBUTING doc to point users at the contributing guide.

For repositories that already have these files, they should continue to get used and these will only show up if a project doesn't have its own.

This ties in with the website contributing guideline updates: typelevel/typelevel.github.com#679

@reardonj
reardonj force-pushed the contributing-guidelines branch from b621990 to 6010797 Compare September 2, 2026 14:11
@reardonj

reardonj commented Sep 2, 2026

Copy link
Copy Markdown
Author

ping @typelevel/maintainers if anyone has opinions on this.

@jducoeur jducoeur left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Makes sense, but a question: does this display sensibly in the new-issue workflow? It's essentially invisible in the rendered view (since everything is a comment), so I'm simply unsure.

@reardonj

reardonj commented Sep 3, 2026

Copy link
Copy Markdown
Author

Makes sense, but a question: does this display sensibly in the new-issue workflow? It's essentially invisible in the rendered view (since everything is a comment), so I'm simply unsure.

It's only new PRs, not new issues (issue can have multiple templates and didn't seem as nice to meddle with).

When you create a new PR, it will be in textbox showing the usual markdown, so it will be quite obvious to the PR creator. I put it in a comment as my experience is people chronically either don't delete these things, or treat them as a checklist to answer instead of reminders. Hopefully the comment keep it from showing up in the PRs regardless of what they do.

@reardonj

reardonj commented Sep 4, 2026

Copy link
Copy Markdown
Author

Site is updated, if someone can merge this.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants