Set Community Standards about inkwell HOT 7 CLOSED

Should we track some ideas here? For instance, contributions now require each added / modified function to be properly documented (maybe tested as well?)

from inkwell.

I've added a PR template. Feel free to provide feedback here on format or content next time you submit a PR.

from inkwell.

It's nice, but I find it a little overwhelming. It looks like it was made for pretty huge commits, and a simple fix or doc change for example requires a pretty long form to be submitted.

from inkwell.

from inkwell.

1. The checklist could instead be a single checkbox that reads "I have read the [Contributing guide](./CONTRIBUTING.md)" or, since GitHub automatically shows a message referring to it, the checklist could be completely removed.
2. "Motivation and Context" doesn't seem extremely relevant. "Why is this change required? What problem does it solve?" are self-explanatory (either through the description, or thanks to the related issue).
3. Some parts should be explicitly optional. For example, an additional "Breaking changes" part would be useful if breaking changes are introduced, and would render the "Types of Change" part useless (since whether it's a bug fix or feature change is answered in the related issue).

Finally, this is a personal preference, but I think moving contribution documents (PR template, Contributing, etc) to /.github is better (it clearly separates the Rust part from the GitHub part).

from inkwell.

Those are all great points. Will take them into consideration. Thanks!

from inkwell.

Addressed COC 4ef6045 and issue templates 7bdd870

from inkwell.