Merge branch 'develop'

.github/.gitmessage.txt

@@ -0,0 +1,25 @@
+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
+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
+by commands like git merge and git revert.
+
+Further paragraphs come after blank lines.
+
+- Bullet points are okay, too
+
+- Typically a hyphen or asterisk is used for the bullet, followed by a single space, with blank lines in between, but conventions vary here
+
+- Use a hanging indent
+
+If you use an issue tracker, add a reference(s) to them at the bottom,
+like so:
+
+Resolves: #123

.github/ISSUE_TEMPLATE/bug-template.md

@@ -0,0 +1,68 @@
+---
+name: '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. -->
+<!-- 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/master/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 **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]
+
+To write a bug report, we have defined a small, helpful workflow, to keep communication effective.
+
+**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 <!-- (optional, e. g. 4.18.1) -->
+
+**2. Actual behaviour:**
+
+[What actually happened]
+[Add logs, code, data, screenshots or other media if available.]
+
+**3. Expected behaviour:**
+
+[What have you expected to happen?]
+
+**4. Steps to reproduce**
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+[Add logs, code, data, screenshots or other media if available.]
+
+**5. Possible solution**
+
+[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:
+
+* Check if all information necessary to understand the problem is in.
+* Check if your language is written in a positive way.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature-template.md

@@ -0,0 +1,33 @@
+---
+name: '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. -->
+<!-- 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/master/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 **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?
+
+### 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).**

.github/ISSUE_TEMPLATE/issue-template.md

@@ -0,0 +1,29 @@
+---
+name: 'Issue'
+about: 'This is a normal issue'
+labels: 'status:incoming'
+---
+
+<!-- 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/master/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.
+* [ ] 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](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 reason for your issue]

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,74 @@
+<!--- Provide a general summary of your changes in the Title above -->
+<!-- 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 -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+*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. -->
+
+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 <!-- (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/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?
+  * TEXT <!-- (Bug fix, feature, improvement, docs) -->
+* [ ] Why is this change required? What problem does it solve?
+  * TEXT
+* [ ] Screenshots (if appropriate)
+* [ ] 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 the changes?
+* [ ] Did the local testing ran successfully?
+* [ ] Did the Continous Integration testing (Travis-CI) ran successfully?
+
+**Commits**
+
+* [ ] 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).
+
+**Others**
+
+* [ ] Is there anything you need from someone else?
+
+### Documentation contribution
+
+* [ ] Have you followed NumPy Docstring standard?
+
+### 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 your changes require additional changes to the documentation?
+
+
+Closes #ISSUE_NUMBER