From 81970bab624d50ecc23de302a511cbc6f7e0d502 Mon Sep 17 00:00:00 2001 From: Egor Panfilov Date: Sat, 20 Feb 2016 22:47:12 +0300 Subject: [PATCH] Added GitHub templates, moved CONTRIBUTING.md to .github --- CONTRIBUTING.txt => .github/CONTRIBUTING.txt | 0 .github/ISSUE_TEMPLATE.md | 15 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 18 ++++++++++++++++++ doc/source/contribute.txt | 2 +- 4 files changed, 34 insertions(+), 1 deletion(-) rename CONTRIBUTING.txt => .github/CONTRIBUTING.txt (100%) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/CONTRIBUTING.txt b/.github/CONTRIBUTING.txt similarity index 100% rename from CONTRIBUTING.txt rename to .github/CONTRIBUTING.txt diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..4cc2832a --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +## Description +[Please provide a general introduction to the issue/proposal.] + +[If reporting a bug, attach the entire traceback from Python.] +[If proposing an enhancement/new feature, provide links to related articles, reference examples, etc.] + + +## Way to reproduce +[If reporting a bug, please include the following important information:] +- [ ] Code example +- [ ] Relevant images (if any) +- [ ] Operating system and version +- [ ] Python version +- [ ] scikit-image version (run `skimage.__version__`) + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..3d884e84 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +## Description +[Tell us about your new feature, improvement, or fix! If relevant, please supplement the PR with images.] + + +## Checklist +[It's fine to submit PRs which are a work in progress! But before they are merged, all PRs should provide:] +- [ ] Clean style in [the spirit of PEP8](https://www.python.org/dev/peps/pep-0008/) +- [ ] [Docstrings for all functions](https://github.com/numpy/numpy/blob/master/doc/example.py) +- [ ] Gallery example in `./doc/examples` (new features only) +- [ ] Unit tests + +[For detailed information on these and other aspects see [scikit-image contribution guidelines](http://scikit-image.org/docs/dev/contribute.html)] + + +## References +[If this is a bug-fix or enhancement, it closes issue # ] +[If this is a new feature, it implements the following paper: ] + diff --git a/doc/source/contribute.txt b/doc/source/contribute.txt index f3404b89..0d3ad00c 100644 --- a/doc/source/contribute.txt +++ b/doc/source/contribute.txt @@ -1,2 +1,2 @@ .. include:: ../../TASKS.txt -.. include:: ../../CONTRIBUTING.txt +.. include:: ../../.github/CONTRIBUTING.txt