numpy / numpy/numpy.org

Add a page on when and how to report issues

Open
#72 1 comment 0 reactions 1 assignee View on GitHub

@rgommers is already working on this.

Since Nov 15, 2019.

content next release
Dominant language
Shell
Stars
128
Forks
132
Avg merge
1d 18h
Merged PRs (30d)
3

Description

See user story at https://github.com/numpy/numpy.org/issues/42#issuecomment-540139059. Having good issue reporting guidelines is quite important, and our current content is insufficient probably.

What we have today:

  1. https://github.com/numpy/numpy/blob/master/.github/ISSUE_TEMPLATE.md
  2. https://numpy.org/devdocs/bugs.html
  3. https://scipy.org/bug-report.html

It should end up in a sub-page or in the docs, and linked from Contribute, Community and Install probably.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.