Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 3.08 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

68 lines (46 loc) · 3.08 KB
Raw

Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.

Thanks for submitting a pull request! It's great, that you want contribute to dataverse_tests. Please provide enough information so that others can review it.

First, start always by reading the Contribution Guide. There you can find all information needed, to create good pull requests.

All Submissions

Describe your environment

  • OS: NAME, VERSION, 64/32bit
  • dataverse_tests: VERSION
  • Python: VERSION
  • Dataverse: VERSION

Follow best practices

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you followed the guidelines in our Contribution Guide?
  • Have you read the Code of Conduct?
  • 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
  • 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

Commits

  • Have descriptive commit messages with a short title (first line).
  • Use the commit message template
  • 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