-
Notifications
You must be signed in to change notification settings - Fork 310
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.
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
doc : add pull request template #61
doc : add pull request template #61
Conversation
Looks good to me. @necolas Thoughts on this? |
I personally prefer a more objective oriented and cleaner PR templates like this: ## What changed / motivation ?
## Linked PR/Issues
## Additional Context
<!--- Screenshots, Tests, Breaking Change, Anything Else ? --->
Then either have a preflight checklist or pre-merge checklist like so: ## Pre-flight checklist
- [ ] I have read the contributing guidelines [LINK GOES HERE](url)
- [ ] I have signed the contributing agreements
- [ ] I have written unit tests where necessary (If it is a feature commit)
- [ ] Performed a self-review of my code
- [ ] More can come here depending on the details of the contributing guidelines... The sample for this PR would look something like: What changed / motivation ?Adds a PR template for new PRs, adds consistency for contributors Linked PR/IssuesAdditional ContextNone Pre-flight checklist
More info: |
thanks @kevintyj for detailed feedback |
@nmn I haven't used PR templates before. I guess I'm a little concerned that having to jump through a lot of hoops makes submitting PRs more tedious, especially for repeat contributors. I don't know that templates make PRs any better |
Hi @necolas, I agree with you. We could opt for a simpler structure, like in other repos. I think having a PR template can serve as a helpful reminder for adhering to conventions and standards in case someone unintentionally misses them. What's your take on this? we can just keep the most imp stuff there |
I share the concerns expressed by @necolas as well. I don't want to put up hurdles to PRs, so I'll leave this PR unmerged for now. |
IMO, PR templates should be easy to fill. Let's find a right balance here. In the other hand, are there any other templates we know are useful? |
Hi @nmn did the changes and shifted the template file to |
Going to merge to try it out for a while. We can revert if we hate it! |
Description
Summary: this PR introduces pull request template file
Fixes #58
Type of change
Added tests?
would request @nmn for feedback , will update acc