search

serokell / universum

:milky_way: Prelude written in @Serokell
MIT License
176 stars 28 forks source link

Added a pull request template #202

Closed JustusAdam closed 6 years ago

JustusAdam commented 6 years ago

I saw stackage do this and I quite like the idea, so I'm proposing it here as well.

This makes the checklist that is in the contribution guide also show up in the text box when opening a new PR.

I did not remove the checklist from the contribution guide, as I could not see how to trivially reword it.

JustusAdam commented 6 years ago

I don't mind keeping you as the author since you're the person who initiated it :)

That is very kind of you.

I figures since I am taking ownership of the authorship I'd make myself useful and I drafted a slightly more elaborate PR template based on your suggestions. I must confess I haven't look at it in rendered form yet (because github kinda does its own thing to some extent when it comes to rendering markdown)

Anyhow I am happy to accept further critique and suggestions relating to the things mentioned in the template. I hope I adequately captured the idea you guys were going for.

JustusAdam commented 6 years ago
  1. I noticed that you removed Description and Related issue(s) sections

Yes, I simply did not realize that they were to be included 🙈

  1. Apparently links to README and CHANGES.md are broken

Sorry about that. I can never rememeber whether they need a / or not. In some contexts github also resolves / to github.com, its thoroughly confusing.

  1. AFAIU, pull_request_template.md name should be lower-case

Sure, no problem. 🙂

JustusAdam commented 6 years ago

If you're happy with that I'll squash and reword the commits.