Issue templates (#526)

* add : `bug_report` template. * add : `feature_request` template. * add : issue temple config file. * log : changelog updated. * remove : old template removed. * updae : `RELEASE.md` updated. * change : request changes applied. * add : mailing list added to `config.yml`. * fix : trying to fix tests. * rename : templates renamed to `yml` from `yaml`. * edit : minor edits in templates. * update : `RELEASE.md` updated. * fix : bug fixed. * doc : RELEASE.md updated * edit : comments applied. --------- Co-authored-by: sepandhaghighi <[email protected]>
sepandhaghighi · Dec 14, 2023 · 7cfdbc7 · 7cfdbc7
1 parent d53fbf4
commit 7cfdbc7
Show file tree

Hide file tree

Showing 7 changed files with 203 additions and 31 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,135 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your time to fill out this bug report!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. [email protected]
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Provide a clear and concise description of what the bug is.
+      placeholder: Tell us a description of the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: step-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Provide details of how to reproduce the bug.
+      placeholder: ex. 1. Go to '...'
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: What did you expect to happen?
+      placeholder: ex. I expected '...' to happen
+    validations:
+      required: true
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      description: What did actually happen?
+      placeholder: ex. Instead '...' happened
+    validations:
+      required: true
+  - type: dropdown
+    id: operating-system
+    attributes:
+      label: Operating system
+      description: Which operating system are you using?
+      options:
+        - Windows
+        - macOS
+        - Linux
+      default: 0
+    validations:
+      required: true
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: Python version
+      description: Which version of Python are you using?
+      options:
+        - Python 3.12
+        - Python 3.11
+        - Python 3.10
+        - Python 3.9
+        - Python 3.8
+        - Python 3.7
+        - Python 3.6
+        - Python 3.5
+      default: 1
+    validations:
+      required: true
+  - type: dropdown
+    id: pycm-version
+    attributes:
+      label: PyCM version
+      description: Which version of PyCM are you using?
+      options:
+        - PyCM 4.0
+        - PyCM 3.9
+        - PyCM 3.8
+        - PyCM 3.7
+        - PyCM 3.6
+        - PyCM 3.5
+        - PyCM 3.4
+        - PyCM 3.3
+        - PyCM 3.2
+        - PyCM 3.1
+        - PyCM 3.0
+        - PyCM 2.9
+        - PyCM 2.8
+        - PyCM 2.7
+        - PyCM 2.6
+        - PyCM 2.5
+        - PyCM 2.4
+        - PyCM 2.3
+        - PyCM 2.2
+        - PyCM 2.1
+        - PyCM 2.0
+        - PyCM 1.9
+        - PyCM 1.8
+        - PyCM 1.7
+        - PyCM 1.6
+        - PyCM 1.5
+        - PyCM 1.4
+        - PyCM 1.3
+        - PyCM 1.2
+        - PyCM 1.1
+        - PyCM 1.0
+        - PyCM 0.9.5
+        - PyCM 0.9
+        - PyCM 0.8.6
+        - PyCM 0.8.5
+        - PyCM 0.8.1
+        - PyCM 0.7
+        - PyCM 0.6
+        - PyCM 0.5
+        - PyCM 0.4
+        - PyCM 0.3
+        - PyCM 0.2
+        - PyCM 0.1
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord
+    url: https://discord.com/invite/zqpU2b3J3f
+    about: Ask questions and discuss with other PyCM community members 
+  - name: Mailing List
+    url: https://mail.python.org/mailman3/lists/pycm.python.org/
+    about: Ask questions and discuss with other PyCM community members
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,32 @@
+name: Feature Request
+description: Suggest a feature for this project
+title: "[Feature]: "
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature you want to add
+      placeholder: I'd like to be able to [...]
+    validations:
+      required: true
+  - type: textarea
+    id: possible-solution
+    attributes:
+      label: Describe your proposed solution
+      placeholder: I think this could be done by [...]
+    validations:
+      required: false
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered, if relevant
+      placeholder: Another way to do this would be [...]
+    validations:
+      required: false
+  - type: textarea
+    id: aditional-context
+    attributes:
+      label: Additional context
+      placeholder: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- `feature_request.yml` template
+- `config.yml` for issue template
 ### Changed
+- Bug report template modified
 - Document modified
 - `README.md` modified
 - Test system modified

diff --git a/Otherfiles/RELEASE.md b/Otherfiles/RELEASE.md
@@ -1,7 +1,7 @@
 
 # PyCM Release Instructions
 
-#### Last Update: 2023-09-25
+#### Last Update: 2023-11-25
 
 1. Create the `release` branch under `dev`
 2. Update all version tags
@@ -15,35 +15,37 @@
 	1. Add a new header under `Unreleased` section (Example: `## [0.1] - 2022-08-17`)
 	2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/sepandhaghighi/pycm/compare/v0.1...v0.2`)
 	3. Update `dev` compare link (Example: `[Unreleased]: https://github.com/sepandhaghighi/pycm/compare/v0.2...dev`)
-4. Update Document
+4. Update `bug_report.yml`
+   1. Add new version tag to `PyCM version` dropbox options
+5. Update Document
 	1. Run `Otherfiles/doc_run.bat`
-5. Create a PR from `release` to `dev`
+6. Create a PR from `release` to `dev`
 	1. Title: `Version x.x` (Example: `Version 0.1`)
 	2. Tag all related issues
 	3. Labels: `release`
 	4. Set milestone
 	5. Set project
 	6. Wait for all CI pass
 	7. Need review (**2** reviewers)
-6. Merge `dev` branch into `master`
+7. Merge `dev` branch into `master`
 	1. `git checkout master`
 	2. `git merge dev`
 	3. `git push origin master`
 	4. Wait for all CI pass
-7. Create a new release
+8. Create a new release
 	1. Target branch: `master`
 	2. Tag: `vx.x` (Example: `v0.1`)
 	3. Title: `Version x.x` (Example: `Version 0.1`)
 	4. Copy changelogs
 	5. Tag all related issues
-8. Bump!!
-9. Close this version issues
-10. Close milestone
-11. Close project
-12. Generate HTML files
+9.  Bump!!
+10. Close this version issues
+11. Close milestone
+12. Close project
+13. Generate HTML files
 	1. Run `Otherfiles/doc_to_html.bat`
 	2. Copy `doc` folder for the next steps
-13. Update website
+14. Update website
 	1. `git checkout gh-pages`
 	2. Update `download.html` page
 		1. Add a new section

diff --git a/Otherfiles/version_check.py b/Otherfiles/version_check.py
@@ -24,15 +24,19 @@
 HTML_ITEMS = ["Version {0}"]
 PARAMS_ITEMS = ['PYCM_VERSION = "{0}"']
 META_ITEMS = ['% set version = "{0}" %']
+ISSUE_TEMPLATE_ITEMS = ["- PyCM {0}"]
 FILES = {
     os.path.join("Otherfiles", "meta.yaml"): META_ITEMS,
-    "setup.py": SETUP_ITEMS, "README.md": README_ITEMS, "CHANGELOG.md": CHANGELOG_ITEMS, os.path.join(
-        "Document", "Document.ipynb"): DOCUMENT_ITEMS, os.path.join(
-            "Document", "Example1_files", "cm1.html"): HTML_ITEMS, os.path.join(
-                "Document", "Example1_files", "cm2.html"): HTML_ITEMS, os.path.join(
-                    "Document", "Example1_files", "cm3.html"): HTML_ITEMS, os.path.join(
-                        "Otherfiles", "test.html"): HTML_ITEMS, os.path.join(
-                            "pycm", "pycm_param.py"): PARAMS_ITEMS}
+    "setup.py": SETUP_ITEMS, "README.md": README_ITEMS,
+    "CHANGELOG.md": CHANGELOG_ITEMS,
+    os.path.join("Document", "Document.ipynb"): DOCUMENT_ITEMS,
+    os.path.join("Document", "Example1_files", "cm1.html"): HTML_ITEMS,
+    os.path.join("Document", "Example1_files", "cm2.html"): HTML_ITEMS,
+    os.path.join("Document", "Example1_files", "cm3.html"): HTML_ITEMS,
+    os.path.join("Otherfiles", "test.html"): HTML_ITEMS,
+    os.path.join("pycm", "pycm_param.py"): PARAMS_ITEMS,
+    os.path.join(".github", "ISSUE_TEMPLATE", "bug_report.yml"): ISSUE_TEMPLATE_ITEMS,
+}
 
 TEST_NUMBER = len(FILES.keys())