Add default PR description about documentation HOT 13 CLOSED

I apologize for the delay but here is what I came up with based on the scikit's PR template. I welcome suggestions on its improvement.

PR Template:

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
• Docstrings for all functions
• Commit messages that follow the instructions given here
• Tests

[For detailed information on these and other aspects see contribution guidelines]

References

[If this is a bug-fix or enhancement, it closes issue # ]

from documentation.

From @gitmate-bot on June 23, 2016 4:6

Thanks for reporting this issue!

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

CC @sils1297, @AbdealiJK

from documentation.

From @AbdealiJK on June 23, 2016 4:7

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

from documentation.

From @hypothesist on July 2, 2016 15:58

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.)

from documentation.

Do you have some content in mind for this?

from documentation.

We should probably have a link to coala.io/commit at least, explain people that they should do rebases and stuff like this. Also mention that people should get assigned to an issue when wanting to work on it.

Btw. @gouravchawla I sent you a community invitation so I can assign you - would you be interested in fixing this? Actually I think this can save us a hell lot of time.

from documentation.

Yes, I would love to work on it. @sils1297

from documentation.

@gouravchawla assigned you 👍

from documentation.

As far as I know, you can use comments in markdown, so instead of

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

we could have

<!-- Tell us about your new feature, improvement, or fix! If relevant, please supplement the PR with images. -->

which doesn't need to be deleted/replaced by the reporter.

from documentation.

Ok, i'll turn that into comments. The checklist would still need to be removed though, isn't it?

from documentation.

is this still needed?

from documentation.

from documentation.

Moved to coala/meta#117

from documentation.