diff options
author | mattip <matti.picus@gmail.com> | 2018-07-05 11:59:20 -0700 |
---|---|---|
committer | mattip <matti.picus@gmail.com> | 2018-07-05 11:59:20 -0700 |
commit | d7c992445eb69867b3bd3180810a6106a6cbf748 (patch) | |
tree | 345a0f47321359166880c71b47b96511c57bb6a0 /.github | |
parent | 739443679b50b43c34808b8fb767bac643fcd91d (diff) | |
download | numpy-d7c992445eb69867b3bd3180810a6106a6cbf748.tar.gz |
DOC: add templates for issues and PR
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 31 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 23 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 1 |
3 files changed, 55 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..01d9a537e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to numpy + +## Reporting issues + +When reporting issues please include as much detail as possible about your +operating system, numpy version and python version. Whenever possible, please +also include a brief, self-contained code example that demonstrates the problem. + +If you are reporting a segfault please include a GDB traceback, which you can +generate by following +[these instructions.](https://github.com/numpy/numpy/blob/master/doc/source/dev/development_environment.rst#debugging) + +## Contributing code + +Thanks for your interest in contributing code to numpy! + ++ If this is your first time contributing to a project on GitHub, please read +through our +[guide to contributing to numpy](https://docs.scipy.org/doc/numpy/dev/index.html) ++ If you have contributed to other projects on GitHub you can go straight to our +[development workflow](https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html) + +Either way, please be sure to follow our +[convention for commit messages](https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#writing-the-commit-message). + +If you are writing new C code, please follow the style described in +``doc/C_STYLE_GUIDE``. + +Suggested ways to work on your development version (compile and run +the tests without interfering with system packages) are described in +``doc/source/dev/development_environment.rst``. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..fd18c3e08 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,23 @@ + +<<Please describe the issue in detail here, and for bug reports fill in the fields below.>> + +### Reproducing code example: +``` +<<A short code example that reproduces the problem. It should be self-contained, i.e., possible to run as-is via 'python myproblem.py'>> +``` + +### Error message: +If you are reporting a segfault please include a GDB traceback, which you can +generate by following +[these instructions.](https://github.com/numpy/numpy/blob/master/doc/source/dev/development_environment.rst#debugging) + +``` +<<Full error message, if any (starting from line Traceback: ...)>> +``` + +### Numpy/Python version information: +``` +<<Output from 'import sys, numpy; print(numpy.__version__, sys.version)'>> +``` + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..7b244ad51 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1 @@ +Be sure you are following the instructions in the [dev guidelines](http://www.numpy.org/devdocs/dev/gitwash/development_workflow.html) especially include a properly formatted [commit message](http://www.numpy.org/devdocs/dev/gitwash/development_workflow.html#writing-the-commit-message). |