diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d65ac5c6e..538e8a5b0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,34 +1,12 @@ - - -## **1. This PR contains the following changes...** - -_Add a summary of the changes and the related issue._ - -## **2. The following additional changes are required for this to work** - -_Add information on additional changes required for the PR changes to work, both locally and in the deployments._ +## Before submitting this PR -> E.g. Does the deployment setup need anything for this to work? +1. **Description:** _Add a summary of the changes in this PR and the related issue._ +2. **Jira task / GitHub issue:** _Link to the github issue or add the Jira task ID here._ +3. **How to test:** _Add information on how someone could manually test this functionality. As detailed as possible._ +4. **Type of change:** [_Check the relevant boxes in the section below_](#what-type-of-changes-does-the-pr-contain) +5. **Add docstrings and comments to code**, _even if_ you personally think it's obvious. -## **3. The PR fixes the following GitHub issue / Jira task** - - - -- [ ] GitHub issue (link): -- [ ] Jira task (ID, `DDS-xxxx`): -- [ ] The PR does not fix a specific GitHub issue or Jira task - -## **4. What _type of change(s)_ does the PR contain?** +## What _type of change(s)_ does the PR contain? - -### **Always** - - +## Checklist - [Changelog](../CHANGELOG.md) - [ ] Added @@ -64,35 +36,11 @@ _Add information on additional changes required for the PR changes to work, both - [ ] Merged - [ ] No blocking PRs - PR to `master` branch - - [ ] Yes: Go to the section [PR to master](#pr-to-master) + - [ ] Yes: Read [the release instructions](../docs/procedures/new_release.md) + - [ ] I have followed steps 1-6. - [ ] No -### If PR consists of **code change(s)** - - - -- Self review - - [ ] Done -- Comments, docstrings, etc - - [ ] Added / Updated -- Documentation - - [ ] Updated - - [ ] Update not needed - -### If PR is to **master** - - - -- [ ] I have followed steps 1-5 in [the release instructions](../docs/procedures/new_release.md) -- [ ] I am bumping the major version (e.g. 1.x.x to 2.x.x) -- [ ] I have made the corresponding changes to the web/API version - -**Is this version _backward compatible?_** - -- [ ] Yes: The code works together with `dds_web/master` branch -- [ ] No: The code **does not** entirely / at all work together with the `dds_web/master` branch. _Please add detailed and clear information about the broken features_ - -## **6. Actions / Scans** +## Actions / Scans diff --git a/CHANGELOG.md b/CHANGELOG.md index 02520b4a5..646a690e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -247,3 +247,4 @@ Please add a _short_ line describing the PR you make, if the PR implements a spe - Bug: Return error code 1 if error during upload ([#615](https://github.com/ScilifelabDataCentre/dds_cli/pull/615)) - Clarification: Users should check that the error-file has been generated, and keep it in case we need it for debugging purposes ([#616](https://github.com/ScilifelabDataCentre/dds_cli/pull/616)) - Bug: Catch UnicodeEncodeError during API request to avoid unclear error message upon usage of non-latin1 characters in username and password ([#617](https://github.com/ScilifelabDataCentre/dds_cli/pull/617)) +- Workflow: Restructure and clarify PR template ([#618](https://github.com/ScilifelabDataCentre/dds_cli/pull/618)) diff --git a/docs/procedures/new_release.md b/docs/procedures/new_release.md index 0722b63d9..74fa3d58d 100644 --- a/docs/procedures/new_release.md +++ b/docs/procedures/new_release.md @@ -28,6 +28,13 @@ 2. Wait for approval and merge by Product Owner or admin 6. Create a PR from `dev` to `master` + - Are you bumping the major version (e.g. 1.x.x to 2.x.x)? + - Yes: Add this info to the PR. + - Do the changes affect the API in any way? + - Yes: + - Add how the API is affected in the PR. + - Make the corresponding changes to the API and create a PR _before_ you merge this PR. + - _Backward compatibility:_ Check whether or not the dds_cli master branch works with the code in the PR. Note if the dds_web changes work with the previous version of the dds_cli. If something might break - give detailed information about what. **The users should be informed of this, e.g. via a MOTD.** - All changes should be approved in the PRs to dev so reviewing the changes a second time in this PR is not necessary. Instead, the team should look through the code just to see if something looks weird. - All sections and checks in the PR template should be filled in and checked. Follow the instruction in the PR description field. - There should be at least one approval of the PR.