search

NLeSC / python-template

Netherlands eScience Center Python Template
https://research-software-directory.org/software/nlesc-python-template
Apache License 2.0
180 stars 76 forks source link

Simplify the current PR Template #670

Open vedran-kasalica opened 1 day ago

vedran-kasalica commented 1 day ago

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!

egpbos commented 1 day ago

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 😄
egpbos commented 1 day ago

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:

<!--
Please describe what your PR adds and why.

Make sure you read and follow the contributing guidelines!
https://github.com/NLeSC/python-template/blob/main/CONTRIBUTING.md
-->
vedran-kasalica commented 1 day ago

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 😄

Oops. I searched for it, by filtering on template (which gave me way too many issues to carefully read all of them) so I went for PR. I forgot to type the long version of PR. So technically it was the quality of my search that was bad, not the check or the template 😅

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.