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 CONTRIBUTING file #826

Merged
merged 1 commit into from
Jul 28, 2014
Merged

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jul 27, 2014

Oftentimes open source projects place a CONTRIBUTING file in the root directory. It explains how a participant should do things like format code, test fixes, and submit patches. Here is a fine example from puppet and another one from factory_girl_rails. From a maintainer's point of view, the document succinctly communicates how best to collaborate. And for a contributor, one quick check of this file verifies their submission follows the maintainer's guidelines.

More info: https://github.com/blog/1184-contributing-guidelines
Another example: http://contribute.md

We can pad it out later, but this can get us started. It's very useful for bug reports to include example code that reproduces the problem, it obviously gives us something concrete to help repro right away, and also is pretty much a test case.

wiredfool added a commit that referenced this pull request Jul 28, 2014
@wiredfool wiredfool merged commit c47bed4 into python-pillow:master Jul 28, 2014
@hugovk hugovk deleted the CONTRIBUTING branch July 28, 2014 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants