Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
add CONTRIBUTING.md #2411
GitHub just added support for a CONTRIBUTING[.md] file, which will be shown to users opening an Issue or Pull Request. This might be helpful for improving the quality of initial bug reports / pull requests, assuming it is sufficiently prominent and concise.
It should include a quick summary of things like:
This comment has been minimized.
This comment has been minimized.Show comment Hide comment
Ohh, this is awesome, we should definitely do this. BUT let's keep in mind that we have developer docs spread all over the place already. Towards the end of the summer we had talked about consolidating our development related docs/wiki stuff to the github wiki. I think we even took an informal poll, but I don't recall if we actually concluded it.