Skip to content

Commit

Permalink
Merge pull request #26 from UAL-RE/feat/25_PR_templates
Browse files Browse the repository at this point in the history
Feat/25 pr templates
  • Loading branch information
yhan818 committed Jun 30, 2022
2 parents db429bb + 00564b8 commit 9afe213
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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)
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug-pull-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- 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 how this PR resolved the specified bug-->

<!-- Add any linked issue(s) -->
See #


*Screenshots or additional context*
<!-- Add any other context about the problem here and/or screenshots to help explain the problem. -->


*Testing (if applicable)*
<!-- Explain how you tested this bug fix so that others can replicate it. -->
<!-- Example: The exact commands you ran and their output. -->
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature-pull-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!-- 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 how this PR addresses the feature/enhancement. -->

<!-- Add any linked issue(s) -->
See #


**ToDo List**

<!-- Add any open questions and Pre-Merge TODOs. Use checkboxes. -->
- [ ] ToDo -->
- [ ] ToDo -->
- [ ] ToDo -->


**Test plan**
<!-- Explain how you tested this feature so that others can replicate it. -->
<!-- Example: The exact commands you ran and their output, screenshots. -->


*Resources*
<!-- Links to blog posts, StackOverflow, libraries or add-ons used to solve this problem. -->


*Screenshots or additional context*
<!-- Add any other context about the problem here and/or screenshots to help explain the problem. -->
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release-pull-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
**Description**
<!-- Do not push the release tag until this PR is merged -->
This pull request updates redata-commons 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 -->

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

**Bump version**

- [ ] [README.md](../../README.md) (if needed)
- [ ] [`setup.py`](../../setup.py)
- [ ] [`redata/__init__.py`](../../redata/__init__.py)
- [ ] ReadTheDocs [`conf.py`](../../docs/source/conf.py)

**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 9afe213

Please sign in to comment.