Skip to content

Commit

Permalink
Merge pull request #174 from UAL-RE/feat/173_PR_templates
Browse files Browse the repository at this point in the history
Improve PR templates
  • Loading branch information
yhan818 committed Jun 28, 2022
2 parents bdc3f26 + 80aacfd commit 6c2770d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 21 deletions.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,5 @@
Click the `Preview` tab and select a PR template:

- [Release](?expand=1&template=release-pull-request.md)
- [Feature](?expand=1&template=feature-pull-request.md)
- [Bug fix](?expand=1&template=bug-pull-request.md)
29 changes: 8 additions & 21 deletions .github/PULL_REQUEST_TEMPLATE/release-pull-request.md
@@ -1,36 +1,23 @@
---
name: Release
about: Provide specifics about a PR for a release
title: 'PR/Release: ____(provide a descriptive name)'
assignees: ''

---
<!-- IMPORTANT: Please do not create a PR without creating an issue first. -->

<!-- Fields in **bold** are REQUIRED, fields in *italics* are OPTIONAL. -->

**Description**
<!-- A description of the updates contained in this release. Example: -->
<!-- Incorporates Travis CI feature #91, summary for script_run #99, and root portal handling #88 -->

Closes #

<!-- Do not push the release tag until this PR is merged -->
This pull request updates ReQUIAM v0.xx.x -> v0.xx.0

**Update Changelog**
<!-- List changes: be brief, use imperative mood or simple noun phrases and add linked issues -->
<!-- Examples: Improve verbosity of log messages #103 | GitHub actions for CI #105 -->

- [ ] README.md, [changelog](../../README.md#changelog) <!-- update changelog here -->

- [ ] [changelog](../../CHANGELOG.md) <!-- update changelog here -->

**Bump version**

v0.xx.x -> v0.xx.0

- [ ] README.md, [installation instructions](../../README.md#installation-instructions)
- [ ] [README.md](../../README.md) (if needed)
- [ ] [`setup.py`](../../setup.py)
- [ ] [`requiam/__init__.py`](../../requiam/__init__.py)
- [ ] ReadTheDocs [`conf.py`](../../docs/source/conf.py)
- [ ] ReadTheDocs [`getting_started.rst`](../../docs/source/getting_started.rst)

**Update Additional Documentation**
- [ ] [ReadTheDocs files](../../docs/source/). Check and update the appropriate sections in the .rst files as needed

*Screenshots or additional context*
<!-- Add any other context about this release. -->

0 comments on commit 6c2770d

Please sign in to comment.