-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Closed
Labels
Milestone
Description
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:
- search the Issues before opening a new one
- If possible, test with current master before the reporting a bug that may already be fixed
- For bugs, include the versions of relevant pacakges, and the output of
print IPython.sys_info()
- first places to look for prospective new contributors (quickfix / docs tags, PR review)
- Pull Request guidelines, etc.