-
Notifications
You must be signed in to change notification settings - Fork 77
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
Simplify the current PR Template #670
Comments
I fully agree, and would suggest to also reduce the issue template; in particular, the checkbox to check for existing issues can be removed, because it adds an unnecessary barrier and doesn't really help*. * This is a duplicate of #643 😉 This means you have not checked the existing issues, as you indicated 😇 Sorry, don't want to be mean and pedantic, just saying: apparently it doesn't work 😄 |
To be more concrete: my suggestion would be to move the entire PR template's contents to the Contribution guidelines (and make sure to remove duplicate info). The remaining PR template can simply be:
|
Oops. I searched for it, by filtering on I like the fact that there was a check that reminded me to search for an issue though. The issue template is quite small, just one checkbox and the description. Maybe the reminder doesn't have to be a checkbox, but a simple text as the one you suggest for the PR template. |
If you think it is helpful, then I agree that's the best way to go! And sorry again for the wise-ass comment 😄 |
The comment was fine, no worries! :) Issue TemplatesAbout the Issue template, I am not sure if a checkbox is better than a simple text that the user deletes. A simple text might be less intimidating to a new contributor (there is no explicit statement). I also have a comment about the issue descriptions,
I would expect this to be the description of issues Should we make a new issue for this or extend this one to include PR TemplateFinally, it would be nice to get more opinions on the PR template. |
Checklist before submitting an issue
Issue details
The current pull request (PR) template feels somewhat convoluted. While all the points are relevant, it could be streamlined to simplify the development process.
One potential improvement is shortening the initial checklist. For example, the following two points could be combined into one:
As far as I understand, the style guidelines are referenced in contribution guidelines.
@NLeSC/python-template-nlesc-team suggestions are welcome!
The text was updated successfully, but these errors were encountered: