Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Define issue and PR guidelines #14

Open
2 tasks
pradal opened this issue Dec 9, 2021 · 2 comments
Open
2 tasks

Define issue and PR guidelines #14

pradal opened this issue Dec 9, 2021 · 2 comments

Comments

@pradal
Copy link
Contributor

pradal commented Dec 9, 2021

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

  • Write the guidelines around it
  • Adapt exist source of inspiration
@thomasarsouze
Copy link
Contributor

List of templates is listed for issues and PR here.

Nice guidelines for Bug Reports are provided here

@thomasarsouze
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pradal @thomasarsouze