pull request template currently provides little additional value

Bioconductor / BiocCheck

http://bioconductor.org/packages/BiocCheck

8 stars 26 forks source link

pull request template currently provides little additional value #108

Closed mtmorgan closed 4 years ago

mtmorgan commented 4 years ago

The BiocCheck pull request template seems to produce a pull request WITH A LOT OF SHOUTING and not much added value at the top (e.g., https://github.com/Bioconductor/BiocCheck/pull/105; https://github.com/Bioconductor/BiocCheck/pull/107) can it be simplified @lcolladotor ?

mtmorgan commented 4 years ago

@lcolladotor can you provide a screenshot or ... that illustrates what a pull request under your revision will look like? For instance there is a reference to 'currently' and 'May', which doesn't seem correct...

lcolladotor commented 4 years ago

Well, the PR removes the YAML lines that add the black bolded text that you found of no real value **. So it only leaves the lines like

taken from https://github.com/Bioconductor/BiocCheck/pull/105. To provide a true screenshot, I would need to fork my already existing fork a second time, then send a PR to my fork.

** It looks like the commit message is added before the YAML code, and that somehow breaks it. So yeah, I think that removing all the YAML is a good solution.

mtmorgan commented 4 years ago

And the mention of May, 2020? Is that necessary / useful?

lcolladotor commented 4 years ago

Ahh, you want to further edit the text? I only thought you wanted to drop all the bold font.

Sure, let me add a small commit to the PR to delete (currently in May 2020 that would be Bioconductor 3.12).