From e4ca03ff16dc7748d335237fcf5322b092c99247 Mon Sep 17 00:00:00 2001 From: percygautam Date: Thu, 16 Jan 2020 02:11:08 +0530 Subject: [PATCH 01/12] Added new PR template --- .github/PR_TEMPLATE/pull_request.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/PR_TEMPLATE/pull_request.md diff --git a/.github/PR_TEMPLATE/pull_request.md b/.github/PR_TEMPLATE/pull_request.md new file mode 100644 index 0000000000..f54252fcfa --- /dev/null +++ b/.github/PR_TEMPLATE/pull_request.md @@ -0,0 +1,16 @@ +## Description + + + +## Change Type + +- [ ] Documentation update +- [ ] Bug fix +- [ ] New feature + +## Checklist: + +- [ ] I am familiar with the [**Contributing Guidelines**](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md). +- [ ] I have read and will abide by [**Code of Conduct**](https://github.com/arviz-devs/arviz/blob/master/CODE_OF_CONDUCT.md). +- [ ] My code follows the [pull request checklist](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist). +- [ ] The changes introduced by this pull request are covered by existing or newly introduced tests. From 4b8925dbedeaaf8d2721f796d482cc8b97480f94 Mon Sep 17 00:00:00 2001 From: percygautam Date: Thu, 16 Jan 2020 20:00:18 +0530 Subject: [PATCH 02/12] Add temlates for bug-fix, documentation and new features --- .github/PR_TEMPLATE/pull_request.md | 16 ------ .github/PULL_REQUEST_TEMPLATE/bug-fix.md | 53 +++++++++++++++++ .../PULL_REQUEST_TEMPLATE/documentation.md | 50 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/new-feature.md | 57 +++++++++++++++++++ 4 files changed, 160 insertions(+), 16 deletions(-) delete mode 100644 .github/PR_TEMPLATE/pull_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/bug-fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/new-feature.md diff --git a/.github/PR_TEMPLATE/pull_request.md b/.github/PR_TEMPLATE/pull_request.md deleted file mode 100644 index f54252fcfa..0000000000 --- a/.github/PR_TEMPLATE/pull_request.md +++ /dev/null @@ -1,16 +0,0 @@ -## Description - - - -## Change Type - -- [ ] Documentation update -- [ ] Bug fix -- [ ] New feature - -## Checklist: - -- [ ] I am familiar with the [**Contributing Guidelines**](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md). -- [ ] I have read and will abide by [**Code of Conduct**](https://github.com/arviz-devs/arviz/blob/master/CODE_OF_CONDUCT.md). -- [ ] My code follows the [pull request checklist](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist). -- [ ] The changes introduced by this pull request are covered by existing or newly introduced tests. diff --git a/.github/PULL_REQUEST_TEMPLATE/bug-fix.md b/.github/PULL_REQUEST_TEMPLATE/bug-fix.md new file mode 100644 index 0000000000..ba05ca87c2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug-fix.md @@ -0,0 +1,53 @@ +## Description + + + + + +## Checklist + + +- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format (described below)? +- [ ] Have you added the unit tests to prevent issue reoccurance( using [pytest fixture pattern]( + (https://docs.pytest.org/en/latest/fixture.html#fixture))? +- [ ] Have you run the unit tests using pytest? +- [ ] Is your code style correct (are you using PEP8, pylint)? + + diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md new file mode 100644 index 0000000000..d4839efaed --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/documentation.md @@ -0,0 +1,50 @@ +## Description + + + +## Checklist + + +- [ ] This PR is following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format (described below). +- [ ] Documentation is [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant. + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE/new-feature.md b/.github/PULL_REQUEST_TEMPLATE/new-feature.md new file mode 100644 index 0000000000..119510b58e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new-feature.md @@ -0,0 +1,57 @@ +## Description + + + + + +## Checklist + + +- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format (described below)? +- [ ] Included a sample plot to visually illustrate your changes? +- [ ] Do all of your functions and methods have docstrings? +- [ ] Have you added/updated unit tests where appropriate( using [pytest fixture pattern]( + (https://docs.pytest.org/en/latest/fixture.html#fixture))? +- [ ] Have you run the unit tests using pytest? +- [ ] Is your code style correct (are you using PEP8, pylint)? +- [ ] Have you added the documentation for your new feature/functionality? + + + From 3450af3846f8928285cbd1e1a609ea8042bfdeed Mon Sep 17 00:00:00 2001 From: percygautam Date: Fri, 17 Jan 2020 19:03:09 +0530 Subject: [PATCH 03/12] changed the templates --- .github/PULL_REQUEST_TEMPLATE/bug-fix.md | 46 +++++++---------- .../PULL_REQUEST_TEMPLATE/documentation.md | 39 +++++++-------- .github/PULL_REQUEST_TEMPLATE/new-feature.md | 50 +++++++++---------- 3 files changed, 59 insertions(+), 76 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/bug-fix.md b/.github/PULL_REQUEST_TEMPLATE/bug-fix.md index ba05ca87c2..a36401edf7 100644 --- a/.github/PULL_REQUEST_TEMPLATE/bug-fix.md +++ b/.github/PULL_REQUEST_TEMPLATE/bug-fix.md @@ -1,31 +1,8 @@ ## Description - - - - - -## Checklist - - -- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) - PR format (described below)? -- [ ] Have you added the unit tests to prevent issue reoccurance( using [pytest fixture pattern]( - (https://docs.pytest.org/en/latest/fixture.html#fixture))? -- [ ] Have you run the unit tests using pytest? -- [ ] Is your code style correct (are you using PEP8, pylint)? - + + + + + +## Checklist + + +- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format (described below)? +- [ ] Has added unit tests to prevent issue recurrence( using [pytest fixture pattern]( + (https://docs.pytest.org/en/latest/fixture.html#fixture))? +- [ ] Is code style correct (are you using pylint, black)? + + - - -## Checklist - - -- [ ] This PR is following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) - PR format (described below). -- [ ] Documentation is [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant. - - - + + + + +## Checklist + + +- [ ] This PR is following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format (described below). +- [ ] Documentation is [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant. + + - - - - -## Checklist - - -- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) - PR format (described below)? -- [ ] Included a sample plot to visually illustrate your changes? -- [ ] Do all of your functions and methods have docstrings? -- [ ] Have you added/updated unit tests where appropriate( using [pytest fixture pattern]( - (https://docs.pytest.org/en/latest/fixture.html#fixture))? -- [ ] Have you run the unit tests using pytest? -- [ ] Is your code style correct (are you using PEP8, pylint)? -- [ ] Have you added the documentation for your new feature/functionality? - - + + + + + +## Checklist + + +- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format (described below)? +- [ ] Included a sample plot to visually illustrate your changes? +- [ ] Do all the added functions and methods have docstrings? +- [ ] Has added/updated unit tests where appropriate( using [pytest fixture pattern]( + (https://docs.pytest.org/en/latest/fixture.html#fixture))? +- [ ] Is code style correct (are you using pylint, black)? +- [ ] Has added documentation for new feature/functionality? + + - - - ## Checklist -- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) - PR format (described below)? +- [ ] Does this PR follow the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format? - [ ] Has added unit tests to prevent issue recurrence( using [pytest fixture pattern]( (https://docs.pytest.org/en/latest/fixture.html#fixture))? -- [ ] Is code style correct (are you using pylint, black)? +- [ ] Is code style correct (follows pylint, black guidelines? - - - ## Checklist -- [ ] This PR is following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) +- [ ] Does this PR follow the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) PR format (described below). - [ ] Documentation is [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant. - - - ## Checklist -- [ ] Is this PR following the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) - PR format (described below)? +- [ ] Does this PR follow the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format? - [ ] Included a sample plot to visually illustrate your changes? - [ ] Do all the added functions and methods have docstrings? - [ ] Has added/updated unit tests where appropriate( using [pytest fixture pattern]( (https://docs.pytest.org/en/latest/fixture.html#fixture))? -- [ ] Is code style correct (are you using pylint, black)? +- [ ] Is code style correct (follows pylint, black guidelines)? - [ ] Has added documentation for new feature/functionality? -- [ ] Does this PR follow the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) +- [ ] Does the PR follow [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) PR format? -- [ ] Has added unit tests to prevent issue recurrence( using [pytest fixture pattern]( - (https://docs.pytest.org/en/latest/fixture.html#fixture))? -- [ ] Is code style correct (follows pylint, black guidelines? +- [ ] Does the PR include new or updated tests to prevent issue recurrence (using [pytest fixture pattern]( + https://docs.pytest.org/en/latest/fixture.html#fixture))? +- [ ] Is code style correct (follows pylint and black guidelines)? -- [ ] Does this PR follow the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) - PR format (described below). -- [ ] Documentation is [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant. +- [ ] Does the PR follow [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) + PR format? +- [ ] Is the documentation [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant? -- [ ] Does this PR follow the [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) +- [ ] Does the PR follow [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) PR format? -- [ ] Included a sample plot to visually illustrate your changes? -- [ ] Do all the added functions and methods have docstrings? -- [ ] Has added/updated unit tests where appropriate( using [pytest fixture pattern]( - (https://docs.pytest.org/en/latest/fixture.html#fixture))? -- [ ] Is code style correct (follows pylint, black guidelines)? -- [ ] Has added documentation for new feature/functionality? +- [ ] Included a sample plot to visually illustrate your changes? (only for plot-related functions) +- [ ] Is the new feature properly documented with an example? +- [ ] Does the PR include new or updated tests to cover the new feature (using [pytest fixture pattern]( + https://docs.pytest.org/en/latest/fixture.html#fixture))? +- [ ] Is code style correct (follows pylint and black guidelines)?