diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 2ed0dc5..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,13 +0,0 @@ -#### Description - -#### Steps/Code to Reproduce - -#### Expected Behavior - -#### Actual Behavior - -#### Operating System - -#### Python Version - -#### OPR Version (Use : `opr.__version__`) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3d44920 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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@example.com + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..5f331c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..139114c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 diff --git a/otherfiles/RELEASE.md b/otherfiles/RELEASE.md index 15beb75..6fccd2c 100644 --- a/otherfiles/RELEASE.md +++ b/otherfiles/RELEASE.md @@ -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 @@ -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` @@ -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 \ No newline at end of file +8. Bump!! +9. Close this version issues +10. Close milestone \ No newline at end of file diff --git a/otherfiles/version_check.py b/otherfiles/version_check.py index 4d715f7..1d27cf5 100644 --- a/otherfiles/version_check.py +++ b/otherfiles/version_check.py @@ -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 = { @@ -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)