Here's the template I've used before in PRs on other projects, I found it helps to encourage people submitting PRs to fill out all relevant sections:
### Summary * bullet point form * is easier to read ### Impact ### Limitations / TODO ### Detail ### Testing ### How To Verify Here's the process I wrote for myself to follow when submitting a PR... a "cheat sheet": https://nuttx-companion.readthedocs.io/en/latest/user/contributing.html -adam On Fri, Mar 20, 2020 at 12:01 PM Abdelatif Guettouche < abdelatif.guettou...@gmail.com> wrote: > > > > @mentors Do we have the ability to add a Git hub PR and Issue template? > > > There at least one project using this: > > https://github.com/apache/incubator-tvm/blob/master/.github/PULL_REQUEST_TEMPLATE.md > I didn't go through all the Apache projects, maybe there are others. > > What do you think should be added in a PR template in our case? Does a > phrase like the one from the link above suffice? > Issues template can be more populated with different templates for bug > reports, help request, etc. > > > On Fri, Mar 20, 2020 at 12:48 PM David Sidrane <david.sidr...@nscdg.com> > wrote: > > > Hi, > > > > > > > > We spend a lot of time on PRs repeating ourselves on format, license. > > > > > > > > Giving directed links and examples will not challenge contributors with > > having to ferret this out on their own. > > > > > > > > @mentors Do we have the ability to add a Git hub PR and Issue template? > > > > > > > > David > > > > > > > > > > > > > > > > *From:* Abdelatif Guettouche [mailto:notificati...@github.com] > > *Sent:* Friday, March 20, 2020 4:42 AM > > *To:* apache/incubator-nuttx > > *Cc:* David Sidrane; Mention > > *Subject:* Re: [apache/incubator-nuttx] Support for Litex VexRiscV (#595) > > > > > > > > @aenrbs New files need to have an Apache license. Kconfig, README and > auto > > generated files like defconfig don't need a license. > > Note that the license holder in all of this PRs files is Gregory Nutt. > > Gregory Nutt has already submitted an ICLA and gave his approval to > change > > his license header. > > > > @davids5 <https://github.com/davids5> As of now, we don't. Some has > > adopted > > their own templates when submitting PRs. > > We may want to add Github's templates for PRs/Issues. Maybe we bring this > > to the dev list for a discussion on what should be there? > > > > — > > You are receiving this because you were mentioned. > > Reply to this email directly, view it on GitHub > > < > https://github.com/apache/incubator-nuttx/pull/595#issuecomment-601657889 > > >, > > or unsubscribe > > < > > > https://github.com/notifications/unsubscribe-auth/AAO3BXP3H2FN5LPATMWNSNTRINJCJANCNFSM4LQFCQSA > > > > > . > > > -- Adam Feuer <a...@starcat.io>
