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.md #2411

Closed
minrk opened this issue Sep 17, 2012 · 1 comment · Fixed by #3674
Closed

add CONTRIBUTING.md #2411

minrk opened this issue Sep 17, 2012 · 1 comment · Fixed by #3674
Milestone

Comments

@minrk
Copy link
Member

minrk commented Sep 17, 2012

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.
@ellisonbg
Copy link
Member

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.

minrk added a commit to minrk/ipython that referenced this issue Jul 17, 2013
GitHub displays this file to users opening new Issues.
It is extracted from our[GitHub Workflow](https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow),
and links there for further details.

closes ipython#2411
mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this issue Nov 3, 2014
GitHub displays this file to users opening new Issues.
It is extracted from our[GitHub Workflow](https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow),
and links there for further details.

closes ipython#2411
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants