Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We need better issue/pull request templates #3750

Open
1 of 5 tasks
Jackenmen opened this issue Apr 13, 2020 · 2 comments
Open
1 of 5 tasks

We need better issue/pull request templates #3750

Jackenmen opened this issue Apr 13, 2020 · 2 comments
Assignees
Labels
Category: Meta This is related to the repository maintenance. Status: Needs Discussion Needs more discussion. Type: Enhancement Something meant to enhance existing Red features.

Comments

@Jackenmen
Copy link
Member

Jackenmen commented Apr 13, 2020

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:

  • 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)
@Jackenmen Jackenmen added Type: Enhancement Something meant to enhance existing Red features. Status: Needs Discussion Needs more discussion. labels Apr 13, 2020
@Jackenmen Jackenmen added the Status: PRs Welcome No one is currently assigned to this issue, but we'd be grateful if anyone made a PR. label May 10, 2020
@Jackenmen Jackenmen removed the Status: PRs Welcome No one is currently assigned to this issue, but we'd be grateful if anyone made a PR. label May 31, 2020
@Drapersniper Drapersniper added the Category: Meta This is related to the repository maintenance. label Jun 26, 2020
@Kowlin Kowlin self-assigned this Feb 1, 2021
@Kowlin
Copy link
Member

Kowlin commented Feb 3, 2021

Theoretically done in #4784?

@Jackenmen
Copy link
Member Author

Part of it is done (which I've already updated in the issue description earlier), but not the whole issue as the PR template is still the same.
There's also the question of whether we want a docs template. I don't think we really need one considering it can easily fall under other available templates, but ¯_(ツ)_/¯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Meta This is related to the repository maintenance. Status: Needs Discussion Needs more discussion. Type: Enhancement Something meant to enhance existing Red features.
Projects
None yet
Development

No branches or pull requests

3 participants