Skip to content

Commit

Permalink
Modern issue template (#23)
Browse files Browse the repository at this point in the history
* doc : modern issue templates added

* fix : issue template added to version_check script

* doc : RELEASE.md updated

* fix : test bug-report template

* fix : test bug-report template 2
  • Loading branch information
sepandhaghighi authored Oct 17, 2024
1 parent 65ef68b commit d5d514f
Show file tree
Hide file tree
Showing 6 changed files with 152 additions and 20 deletions.
13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
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.13
- Python 3.12
- Python 3.11
- Python 3.10
- Python 3.9
- Python 3.8
- Python 3.7
- Python 3.6
default: 1
validations:
required: true
- type: dropdown
id: opr-version
attributes:
label: OPR version
description: Which version of OPR are you using?
options:
- OPR 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
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Discord
url: https://discord.gg/8mBspwXqcA
about: Ask questions and discuss with other OPR community members
- name: Website
url: https://openscilab.com/
about: Check out our website for more information
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
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: additional-context
attributes:
label: Additional context
placeholder: >
Add any other context or screenshots about the feature request here.
validations:
required: false
16 changes: 9 additions & 7 deletions otherfiles/RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OPR Release Instructions

**Last Update: 2024-09-17**
**Last Update: 2024-10-16**

1. Create the `release` branch under `dev`
2. Update all version tags
Expand All @@ -13,7 +13,9 @@
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/openscilab/opr/compare/v0.1...v0.2`)
3. Update `dev` compare link (Example: `[Unreleased]: https://github.com/openscilab/opr/compare/v0.2...dev`)
4. Create a PR from `release` to `dev`
4. Update `.github/ISSUE_TEMPLATE/bug_report.yml`
1. Add new version tag to `OPR version` dropbox options
5. Create a PR from `release` to `dev`
1. Title: `Version x.x` (Example: `Version 0.1`)
2. Tag all related issues
3. Labels: `release`
Expand All @@ -22,17 +24,17 @@
6. Need review (**2** reviewers)
7. Squash and merge
8. Delete `release` branch
5. Merge `dev` branch into `main`
6. Merge `dev` branch into `main`
1. `git checkout main`
2. `git merge dev`
3. `git push origin main`
4. Wait for all CI pass
6. Create a new release
7. Create a new release
1. Target branch: `main`
2. Tag: `vx.x` (Example: `v0.1`)
3. Title: `Version x.x` (Example: `Version 0.1`)
4. Copy changelogs
5. Tag all related issues
7. Bump!!
8. Close this version issues
9. Close milestone
8. Bump!!
9. Close this version issues
10. Close milestone
2 changes: 2 additions & 0 deletions otherfiles/version_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"[{0}]:"]
PARAMS_ITEMS = ['OPR_VERSION = "{0}"']
META_ITEMS = ['% set version = "{0}" %']
ISSUE_TEMPLATE_ITEMS = ["- OPR {0}"]
SECURITY_ITEMS = ["| {0} | :white_check_mark: |"]

FILES = {
Expand All @@ -28,6 +29,7 @@
"CHANGELOG.md": CHANGELOG_ITEMS,
"SECURITY.md": SECURITY_ITEMS,
os.path.join("opr", "params.py"): PARAMS_ITEMS,
os.path.join(".github", "ISSUE_TEMPLATE", "bug_report.yml"): ISSUE_TEMPLATE_ITEMS,
}

TEST_NUMBER = len(FILES)
Expand Down

0 comments on commit d5d514f

Please sign in to comment.