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.

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

Add default PR description #2389

Closed
AbdealiLoKo opened this issue Jun 23, 2016 · 4 comments
Closed

Add default PR description #2389

AbdealiLoKo opened this issue Jun 23, 2016 · 4 comments

Comments

@AbdealiLoKo
Copy link
Contributor

I was submitting a patch at scikit-image and I was really impressed with their default PR message:

## Description
[Tell us about your new feature, improvement, or fix! If relevant, please supplement the PR with images.]


## Checklist
[It's fine to submit PRs which are a work in progress! But before they are merged, all PRs should provide:]
- [ ] Clean style in [the spirit of PEP8](https://www.python.org/dev/peps/pep-0008/)
- [ ] [Docstrings for all functions](https://github.com/numpy/numpy/blob/master/doc/example.py)
- [ ] Gallery example in `./doc/examples` (new features only)
- [ ] Unit tests

[For detailed information on these and other aspects see [scikit-image contribution guidelines](http://scikit-image.org/docs/dev/contribute.html)]


## References
[If this is a bug-fix or enhancement, it closes issue # ]
[If this is a new feature, it implements the following paper: ]

The checklist is really nice and serves as a better reminder of "things to do" as compared to writing it in a documentation.

@gitmate-bot
Copy link
Collaborator

Thanks for reporting this issue!

Your aid is required, fellow coalaian. Help us triage and solving this issue!

CC @sils1297, @AbdealiJK

@AbdealiLoKo
Copy link
Contributor Author

You can find their other templates and this one at https://github.com/scikit-image/scikit-image/tree/master/.github

@adtac
Copy link
Member

adtac commented Jul 2, 2016

We could also add something about doctests. Also modify the first check point to something like "Run coala on the project before submitting" as that should pretty much cover any code standards issue. (We could also convince scikit-image devs to use coala.)

@Adrianzatreanu
Copy link
Contributor

This issue was moved to coala/documentation#31

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants