Define issue and PR guidelines

openalea / openalea.rtfd.io

OpenAlea main documentation site

https://openalea.readthedocs.io/en/latest

5 stars 7 forks source link

Define issue and PR guidelines #14

Open pradal opened 2 years ago

pradal commented 2 years ago

Github allow to define template to fill a new issue or PR.

[ ] Write the guidelines around it
[ ] Adapt exist source of inspiration

thomasarsouze commented 2 years ago

List of templates is listed for issues and PR here.

Nice guidelines for Bug Reports are provided here

thomasarsouze commented 2 years ago

Github provides an issue form templates on .yaml format. Simply need to add a ISSUE_TEMPLATE directory inside .github directory of the project. Seems quite handy and nicer fo the user.

eg. scipy or xarray project use it.

I couldn't find any equivalent for PR, and so far .md templates still seem to be the rule.