Pmbootstrap: Add Issues and PullRequest templates

Created on 11 Mar 2018  路  8Comments  路  Source: postmarketOS/pmbootstrap

As mentioned in this page: https://github.com/postmarketOS/pmbootstrap/community
they suggest to add templates to the new Issues and PullRequests.
I've noticed that some @ollieparanoid 's Pull Requests are very structured and it also simplify reviewing and testing them.

Something like:

  • Introduction
  • Problem
  • Proposed solution
  • Changes
  • Testing
  • Fixes #(number)

What you think?

For new issues it will be a little bit harder, since we have various types (issues, help requests, new features,...). I've no idea what we can use as template.

enhancement infrastructure

All 8 comments

Good idea!

Quite a few pull requests are about new devices, maybe we could add something specific there too. For example, recommend checking if there's still a CHANGEME in the linux package, or if the device has been added to the wiki.

For the issues, recommending to upload the entire aport and linking it (for porting problems), as well as posting the full log would be very helpful.

nheko has such a template we could use as base (note the HTML comments that don't get shown when the issue is created, this is quite useful I think):
https://github.com/mujx/nheko/edit/master/.github/ISSUE_TEMPLATE.md

Nice found @z3ntu, so we can have a default template for issue with some HTML comments to show the links to the various template and also have a page on the wiki to link directly the new different types of issues

After thinking about this for some time: Having template links is nice, but people may open new PRs without searching for the link with the right template first, so here's a version that has it all in one template: #1434

The templates are now linked from the "New issue" page as seen here: https://github.com/babel/babel/issues/new/choose

@z3ntu: that looks nice! Do you want to split the templates up?

Which templates do we want to have? We could split them up into pmbootstrap, osk-sdl (refer to the other repo), kernel issue and X11/Wayland/other userspace program issue - which are the dots in the current issue template. But I also think it's good enough leaving it like it is currently as the template is rather small.

TBH then I'd leave it like it is until it grows some more, and split it then.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

montvid picture montvid  路  3Comments

erhoof picture erhoof  路  4Comments

Decatf picture Decatf  路  4Comments

MartijnBraam picture MartijnBraam  路  6Comments

pavelmachek picture pavelmachek  路  7Comments