Adding pull request template (#6)

* Update issue templates * Use forms for issue templates * fix version, add punctuation and test pycache to gitignore * adding PR template, fixes AgnostiqHQ/covalent-staging#295 * Fixing some typos in the issue templates Co-authored-by: Faiyaz Hasan <[email protected]>
AgnostiqHQ · Jan 25, 2022 · a7bd717 · a7bd717
1 parent 74ccbd0
commit a7bd717
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 6 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml
@@ -1,5 +1,5 @@
 name: 🐛 Bug report
-description: Create a report to help us improve 🤔.
+description: Create a report to help us improve.
 labels: ["bug"]
 
 body:
@@ -10,12 +10,12 @@ body:
   - type: textarea
     attributes:
       label: Environment
-      description: For the version of Covalent, please give the actual version number (_e.g._ 0.18.3) if you are using a release version, or the first 7-8 characters of the commit hash if you have installed from `git`.  If anything else is relevant, you can add it to the list.
+      description: For the version of Covalent, please give the actual version number (_e.g._ 0.18.3) if you are using a release version, or the first 7-8 characters of the commit hash if you have installed from `git`.
       # The trailing spaces on the following lines are to make filling the form
       # in easier.  The type is 'textarea' rather than three separate 'input's
       # to make the resulting issue body less noisy with headings.
       value: |
-        - **Qiskit Terra version**: 
+        - **Covalent version**: 
         - **Python version**: 
         - **Operating system**: 
     validations:

diff --git a/.github/ISSUE_TEMPLATE/DOCUMENTATION_IMPROVEMENT.yaml b/.github/ISSUE_TEMPLATE/DOCUMENTATION_IMPROVEMENT.yaml
@@ -1,4 +1,4 @@
-name: 📝 Feature request
+name: 📝 Documentation
 description: Propose an improvement in documentation.
 labels: ["documentation"]
 

diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yaml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yaml
@@ -1,5 +1,5 @@
 name: 🚀 Feature request
-description: Suggest an idea for this project 💡!
+description: Suggest an idea for this project.
 labels: ["feature"]
 
 body:

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+<!--
+⚠️ Your pull request title should be short detailed and understandable for all.
+⚠️ Increment the version number in the /VERSION file. If this is a bugfix, increment the patch version (the rightmost number), for example 0.18.2 becomes 0.18.3. If it's a new feature, increment the minor version (the middle number), for example 0.18.2 becomes 0.19.0. 
+⚠️ Add a note to /CHANGELOG.md with your version number and the date, summarizing the changes.
+⚠️ If your pull request fixes an open issue, please link to the issue.
+⚠️ Rebase the latest changes from the develop branch. Assuming origin points to https://github.com/AgnostiqHQ/covalent, you should run git rebase origin/develop.
+
+- [ ] I have added the tests to cover my changes.
+- [ ] I have updated the documentation, VERSION, and CHANGELOG accordingly.
+- [ ] I have read the CONTRIBUTING document.
+-->
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.21.0] - 2022-01-25
+
+### Added
+
+- GitHub pull request templates
+
 ## [0.20.0] - 2022-01-25
 
 ### Added

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.20.0
+0.21.0