Update .github files

- pull request template - bug report template - feature request template - issue template - commit message template - add config.yml
AUSSDA · Jan 26, 2021 · 090de82 · 090de82
1 parent e2c90f1
commit 090de82
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 71 deletions.
diff --git a/.github/.gitmessage.txt b/.github/.gitmessage.txt
@@ -1,14 +1,14 @@
 Capitalized, short (50 chars or less) summary (#123)
 
 More detailed explanatory text, if necessary.  Wrap it to about 72
-characters or so.  In some contexts, the first line is treated as the
-subject of an email and the rest of the text as the body.  The blank
+characters or so. In some contexts, the first line is treated as the
+subject of an email and the rest of the text as the body. The blank
 line separating the summary from the body is critical (unless you omit
 the body entirely); tools like rebase can get confused if you run the
 two together.
 
 Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
- or "Fixes bug."  This convention matches up with commit messages generated
+or "Fixes bug."  This convention matches up with commit messages generated
 by commands like git merge and git revert.
 
 Further paragraphs come after blank lines.

diff --git a/.github/ISSUE_TEMPLATE/bug-template.md b/.github/ISSUE_TEMPLATE/bug-template.md
@@ -1,26 +1,31 @@
 ---
 name: 'Bug Report'
-about: 'This is a bug report'
+about: 'This is a bug report issue'
 labels: 'type:bug, status:incoming'
 ---
 
-<!---Provide a general summary of your problem in the Title above. -->
+<!-- Provide a general summary of your problem in the Title above. -->
 <!-- You can erase any parts of this template not applicable to your Issue. -->
-<!-- Please check the checkboxes, if you have finished the step. -->
+<!-- Show that you have done a step, by checking the checkboxes. -->
 
 Thank you for your contribution!
 
 It's great, that you want contribute to pyDataverse.
 
+First, start by reading the [Bug reports, enhancement requests and other issues](https://pydataverse.readthedocs.io/en/develop/contributing/contributing.html) section.
+
 ### Before we can start
 
 Before moving on, please check some things first:
 
-* [ ] Your issue may already be reported! Please search on the [issue tracker](https://github.com/GDCC/pyDataverse/issues) before creating one.
-* [ ] Are you running the expected version of pyDataverse? (check via `pip freeze`).
-* [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome. For more information, see the contributor guide in the [docs](https://pydataverse.readthedocs.io/).
+* [ ] Your issue may already be reported! Please search on the [issue tracker](https://github.com/gdcc/pyDataverse/issues) before creating one.
+* [ ] Is this something you can **debug and fix**? Send a pull request! For more information, see the [Contributor Guide](https://pydataverse.readthedocs.io/en/master/contributing/contributing.html).
 * [ ] We as maintainers foster an open and welcoming environment. Be respectfull, supportive and nice to each other! :)
 
+### Prerequisites
+
+* [ ] Are you running the expected version of pyDataverse? (check via `pip freeze`).
+
 ### Bug report
 
 [Please replace this line with a brief summary of your issue and add code and/or screenshots or other media to it if available]
@@ -29,19 +34,19 @@ To write a bug report, we have defined a small, helpful workflow, to keep commun
 
 **1. Describe your environment**
 
-- OS: name, version, 64/32bit (e. g. Linux, Ubuntu 18.04, 64bit)
-- pyDataverse version (e. g. 0.2.1)
-- Python version (e. g. 3.6.9)
-- Dataverse version (if used) (e. g. 4.18.1)
+* [ ] OS: NAME, VERSION, 64/32bit <!-- (e. g. Linux, Ubuntu 18.04, 64bit) -->
+* [ ] pyDataverse: VERSION <!-- (e. g. 0.2.1) -->
+* [ ] Python: VERSION <!-- (e. g. 3.6.9) -->
+* [ ] Dataverse: VERSION <!-- (optional, e. g. 4.18.1) -->
 
-**2. Actual behavior:** 
+**2. Actual behaviour:**
 
 [What actually happened]
 [Add logs, code, data, screenshots or other media if available.]
 
-**3. Expected behavior:** 
+**3. Expected behaviour:**
 
-[What you expected to happen]
+[What have you expected to happen?]
 
 **4. Steps to reproduce**
 
@@ -53,21 +58,11 @@ To write a bug report, we have defined a small, helpful workflow, to keep commun
 
 **5. Possible solution**
 
-[If you have a clue, tell what could be the actual solution for the problem]
+[If you have a clue, tell what could be the actual solution to the problem]
 
 **6. Check your bug report**
 
-Before you submit the issue
+Before you submit the issue:
 
 * Check if all information necessary to understand the problem is in.
 * Check if your language is written in a positive way.
-
-**What happens after the issue creation?**
-
-After you submitted the issue, the following steps will be coordinated by the Issue Manager (skasberger):
-
-* Decide, if the issue is valid or not.
-* Decide further actions, label the issue properly and assign the issue to someone.
-* Fix the issue (by assigned person).
-* Test and review the actions.
-* Close the issue
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature-template.md b/.github/ISSUE_TEMPLATE/feature-template.md
@@ -1,33 +1,33 @@
 ---
 name: 'Feature Request'
-about: 'This is a feature request'
+about: 'This is a feature request issue'
 labels: 'type:feature, status:incoming'
 ---
 
-<!--- Provide a general summary of your changes in the Title above -->
+<!-- Provide a general summary of your changes in the Title above. -->
 <!-- You can erase any parts of this template not applicable to your Issue. -->
 <!-- Show that you have done a step, by checking the checkboxes. -->
 
 Thank you for your contribution!
 
 It's great, that you want contribute to pyDataverse.
 
+First, start by reading the [Bug reports, enhancement requests and other issues](https://pydataverse.readthedocs.io/en/develop/contributing/contributing.html) section.
+
 ### Before we can start
 
 Before moving on, please check some things first:
 
-* [ ] Your issue may already be reported! Please search on the [issue tracker](https://github.com/GDCC/pyDataverse/issues) before creating one.
-* [ ] Is this something you can **develop**? Send a pull request! For more information, see the contributor guide in the [docs](https://pydataverse.readthedocs.io/).
+* [ ] Your issue may already be reported! Please search on the [issue tracker](https://github.com/gdcc/pyDataverse/issues) before creating one.
+* [ ] Is this something you can **debug and fix**? Send a pull request! For more information, see the [Contributor Guide](https://pydataverse.readthedocs.io/en/master/contributing/contributing.html).
 * [ ] We as maintainers foster an open and welcoming environment. Be respectfull, supportive and nice to each other! :)
 
 ### Prerequisites
 
 * [ ] Are you running the latest version?
 
-For more information, see the [CONTRIBUTING](https://github.com/GDCC/pyDataverse/tree/master/CONTRIBUTING.md) guide.
-
 ### Feature Request
 
 We will consider your request but it may be closed if it's something we're not actively planning to work on.
 
-**Please note by far the quickest way to get a new feature is to file a [Pull Request](https://github.com/GDCC/pyDataverse/pulls).**
+**Please note: By far the quickest way to get a new feature is to file a [Pull Request](https://github.com/gdcc/pyDataverse/pulls).**
diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md
@@ -1,26 +1,29 @@
 ---
 name: 'Issue'
-about: 'This is an issue'
+about: 'This is a normal issue'
 labels: 'status:incoming'
 ---
 
-<!--- Provide a general summary of your changes in the Title above -->
+<!-- Provide a general summary of your changes in the Title above. -->
 <!-- You can erase any parts of this template not applicable to your Issue. -->
+<!-- Show that you have done a step, by checking the checkboxes. -->
 
 Thank you for your contribution!
 
 It's great, that you want contribute to pyDataverse.
 
+First, start by reading the [Bug reports, enhancement requests and other issues](https://pydataverse.readthedocs.io/en/develop/contributing/contributing.html) section.
+
 ### Before we can start
 
 Before moving on, please check some things first:
 
-* [ ] Your issue may already be reported! Please search on the [issue tracker](https://github.com/GDCC/pyDataverse/issues) before creating one.
+* [ ] Your issue may already be reported! Please search on the [issue tracker](https://github.com/gdcc/pyDataverse/issues) before creating one.
 * [ ] Use our issue templates for bug reports and feature requests, if that's what you need.
 * [ ] Are you running the expected version of pyDataverse? (check via `pip freeze`).
-* [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome. For more information, see the contributor guide in the [docs](https://pydataverse.readthedocs.io/).
+* [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome. For more information, see the [Contributor Guide](https://pydataverse.readthedocs.io/en/master/contributing/contributing.html).
 * [ ] We as maintainers foster an open and welcoming environment. Be respectfull, supportive and nice to each other! :)
 
 ### Issue
 
-[Explain the interest behind your issue creation]
+[Explain the reason for your issue]
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,6 @@
 <!--- Provide a general summary of your changes in the Title above -->
-<!-- You can erase any parts of this template not applicable to your Issue. -->
+<!-- You can erase any parts of this template not applicable to your Pull Request. -->
+<!-- Show that you have done a step, by checking the checkboxes and/or adding the requested information. -->
 
 <!--- This project only accepts pull requests related to open issues -->
 <!--- If suggesting a new feature or change, please discuss it in an issue first -->
@@ -8,56 +9,66 @@
 
 *Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
 
-<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
+<!-- You can skip this if you're fixing a typo. -->
 
-Thanks for submitting a pull request! It's great, that you want contribute to pyDataverse. Please provide enough information so that others can review it
+Thanks for submitting a pull request! It's great, that you want contribute to pyDataverse. Please provide enough information so that others can review it.
+
+First, start always by reading the [Contribution Guide](https://pydataverse.readthedocs.io/en/master/contributing/contributing.html). There you can find all information needed, to create good pull requests.
 
 ### All Submissions
 
 **Describe your environment**
 
-* [ ] OS: name, version, 64/32bit (e. g. Linux, Ubuntu 18.04, 64bit)
-* [ ] pyDataverse version (e. g. 0.2.1)
-* [ ] Python version (e. g. 3.6.9)
-* [ ] Dataverse version (if used) (e. g. 4.18.1)
+* [ ] OS: NAME, VERSION, 64/32bit <!-- (e. g. Linux, Ubuntu 18.04, 64bit) -->
+* [ ] pyDataverse: VERSION <!-- (e. g. 0.2.1) -->
+* [ ] Python: VERSION <!-- (e. g. 3.6.9) -->
+* [ ] Dataverse: VERSION <!-- (optional, e. g. 4.18.1) -->
 
 **Follow best practices**
 
-* [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/GDCC/pyDataverse/pulls) for the same update/change?
-* [ ] Have you followed the guidelines in our [Contribution Guide](https://pydataverse.readthedocs.io/)?
-* [ ] Have you used pre-commit?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/gdcc/pyDataverse/pulls) for the same update/change?
+* [ ] Have you followed the guidelines in our [Contribution Guide](https://pydataverse.readthedocs.io/en/master/contributing/contributing.html)?
+* [ ] Have you read the [Code of Conduct](https://github.com/gdcc/pyDataverse/blob/master/CODE_OF_CONDUCT.md)?
+* [ ] Do your changes in a seperate branch. Branches MUST have descriptive names.
+* [ ] Have you merged the latest changes from upstream to your branch?
 
 **Describe the PR**
 
-* [ ] What kind of change does this PR introduce? (Bug fix, feature, improvement, docs)
+* [ ] What kind of change does this PR introduce?
+  * TEXT <!-- (Bug fix, feature, improvement, docs) -->
 * [ ] Why is this change required? What problem does it solve?
-* [ ] Do your changes in a seperate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/login-issue` or `feature/user-api`.
+  * TEXT
 * [ ] Screenshots (if appropriate)
-* [ ] Put `Closes #ISSUE_NUMBER` to the end of this pull request (replace ISSUE_NUMBER with the actual PR issue number).
+* [ ] Put `Closes #ISSUE_NUMBER` to the end of this pull request <!-- (e. g. Closes #1234) -->
 
 **Testing**
 
-* [ ] Have you used tox and/or pytest for testing?
-* [ ] Which tests did you execute?
-* [ ] Have you run all the tests successfully?
+* [ ] Have you used tox and/or pytest for testing the changes?
+* [ ] Did the local testing ran successfully?
+* [ ] Did the Continous Integration testing (Travis-CI) ran successfully?
+
+**Commits**
 
-**Commit**
+* [ ] Have descriptive commit messages with a short title (first line).
+* [ ] Use the [commit message template](https://github.com/gdcc/pyDataverse/blob/master/.github/.gitmessage.txt)
+* [ ] Put `Closes #ISSUE_NUMBER` in your commit messages to auto-close the issue that it fixes (if such).
 
-* [ ] Have a descriptive commit message with a short title (first line).
-* [ ] Put `closes #XXXX` in your commit message to auto-close the issue that your PR fixes (if such).
+**Others**
+
+* [ ] Is there anything you need from someone else?
 
-### New Feature Submissions
+### Documentation contribution
 
-If you have implemented a whole new feature, please follow the steps from "All Submissions", plus the ones following:
+* [ ] Have you followed NumPy Docstring standard?
 
-* [ ] Have you written new tests for your core changes, as applicable?
-* [ ] Have you successfully ran tests with your changes locally?
-* [ ] Does your submission pass tests on Travis?
-* [ ] Have you lint your code locally prior to submission?
-* [ ] Have you formatted your code with black locally prior to submission (e. g. via pre-commit)?
+### Code contribution
+
+* [ ] Have you used pre-commit?
+* [ ] Have you formatted your code with black prior to submission (e. g. via pre-commit)?
+* [ ] Have you written new tests for your changes?
+* [ ] Have you ran mypy on your changes successfully?
 * [ ] Have you documented your update (Docstrings and/or Docs)?
-* [ ] Do changes requires a change to the documentation?
-* [ ] Is there anything you need from someone else?
-* [ ] 
+* [ ] Do your changes require additional changes to the documentation?
+
 
 Closes #ISSUE_NUMBER
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -46,8 +46,8 @@ unacceptable behaviour (see :ref:`community_contact`).
 
 .. _contributing_create-issues:
 
-Bug reports and enhancement requests
------------------------------------------
+Bug reports, enhancement requests and other issues
+----------------------------------------------------
 
 Bug reports are an important part of making pyDataverse more stable. Having
 a complete bug report will allow others to reproduce the bug and provide