Cog-Creators / Cog-Creators/Red-DiscordBot

We need better issue/pull request templates

Open
#3,750 2 comments 0 reactions 1 assignee Claimed by @Kowlin View on GitHub
Category: Meta Status: Needs Discussion Type: Enhancement
Dominant language
Python
Stars
5.7k
Forks
2.5k
Avg merge
6d 16h
Merged PRs (30d)
1

Description

*How better?* I don't know!

Currently this issue contains only what *I think* could be useful, this needs more discussion but there are plenty things we could improve in our templates.

New templates that could be added:
- [x] Issue template for enhancements
- [ ] Issue template for documentation (?)

Improvements to existing templates that we could use:
- [ ] Checklist in pull request template, for example:
- If code changes were made, they have been tested
- I've updated the documentation (if applies)
- If this PR fixes an issue, I referenced them in the PR's description
- My code follow the code style of this project (Black)
- etc.
- [ ] Mention that lack of issue (or other prior discussion) may result in rejection
- [ ] Maybe add more types to choose from in pull request template (assuming the checklist from previous point won't just completely replace it)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.