Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modern templates #265

Merged
merged 8 commits into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

157 changes: 157 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
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: Art-version
attributes:
label: Art version
description: Which version of Art are you using?
options:
- Art 6.1
- Art 6.0
- Art 5.9
- Art 5.8
- Art 5.7
- Art 5.6
- Art 5.5
- Art 5.4
- Art 5.3
- Art 5.2
- Art 5.1
- Art 5.0
- Art 4.9
- Art 4.8
- Art 4.7
- Art 4.6
- Art 4.5
- Art 4.4
- Art 4.3
- Art 4.2
- Art 4.1
- Art 4.0
- Art 3.9
- Art 3.8
- Art 3.7
- Art 3.6
- Art 3.5
- Art 3.4
- Art 3.3
- Art 3.2
- Art 3.1
- Art 3.0
- Art 2.9
- Art 2.8
- Art 2.7
- Art 2.6
- Art 2.5
- Art 2.4
- Art 2.3
- Art 2.2
- Art 2.1
- Art 2.0
- Art 1.9
- Art 1.8
- Art 1.7
- Art 1.6
- Art 1.5
- Art 1.4
- Art 1.3
- Art 1.2
- Art 1.1
- Art 1.0
- Art 0.9
- Art 0.8
- Art 0.7
- Art 0.6
- Art 0.5
- Art 0.4
- Art 0.3
- Art 0.2
- Art 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
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord
url: https://discord.com/invite/FAAyq3QJqP
about: Ask questions and discuss with other art community members
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Art

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/decoration_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Decoration Request
description: Suggest a new decoration to be added to the package
title: "[Decoration]: "
body:
- type: textarea
id: description
attributes:
label: Write the decoration you want to add
placeholder: >
ex: ▌│█║▌║▌║
validations:
required: false
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this item should be true

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 7dcf2a6.

- type: textarea
id: aditional-context
attributes:
label: Additional context
placeholder: >
If you have any additional context or information about the 1-line art (like the link to the source of it), please write it down here.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About the decoration

validations:
required: false
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: aditional-context
attributes:
label: Additional context
placeholder: >
Add any other context or screenshots about the feature request here.
validations:
required: false
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/font_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Font Request
description: Suggest a new font to be added to the package
title: "[Font]: "
body:
- type: textarea
id: link-to-font
attributes:
label: Link to font
placeholder: >
Add a link to the font you want to be added to the package.
validations:
required: true
- type: textarea
id: aditional-context
attributes:
label: Additional context
placeholder: >
If you have any additional context or information about the font (like examples of it), please write it down here.
validations:
required: false
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/one_line_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: 1-Line art Request
description: Suggest a new 1-Line art to be added to the package
title: "[1-Line Art]: "
body:
- type: textarea
id: description
attributes:
label: Write the 1-Line art you want to add
placeholder: >
ex: (っ◕‿◕)っ
validations:
required: false
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this item should be true

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 7dcf2a6.

- type: textarea
id: aditional-context
attributes:
label: Additional context
placeholder: >
If you have any additional context or information about the 1-line art (like the link to the source of it), please write it down here.
validations:
required: false
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@ 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
- `decoration_request.yml` template
- `font_request.yml` template
- `one_line_request.yml` template
- `feature_request.yml` template
- `config.yml` for issue template
### Changed
- Bug report template modified
- Test system modified
- `Python 3.12` added to `test.yml`
## [6.1] - 2023-09-20
Expand Down
24 changes: 13 additions & 11 deletions otherfile/RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Art Release Instructions

#### Last Update: 2023-09-13
#### Last Update: 2024-01-12

1. Create the `release` branch under `dev`
2. Update all version tags
Expand All @@ -27,35 +27,37 @@
1. Add a new header under `Unreleased` section (Example: `## [0.2] - 2022-08-17`)
2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/sepandhaghighi/art/compare/v0.1...v0.2`)
3. Update `dev` compare link (Example: `[Unreleased]: https://github.com/sepandhaghighi/art/compare/v0.2...dev`)
8. Update Document
8. Update `.github/ISSUE_TEMPLATE/bug_report.yml`
1. Add new version tag to `Art version` dropbox options
9. Update Document
1. Run `otherfile/doc_run.bat`
9. Create a PR from `release` to `dev`
10. 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 (**1** reviewer)
10. Merge `dev` branch into `master`
11. Merge `dev` branch into `master`
1. Checkout to `master`
2. `git merge dev`
3. `git push origin master`
4. Wait for all CI pass
11. Create a new release
12. 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
12. Bump!!
13. Close this version issues
14. Close milestone
15. Close project
16. Generate HTML files
13. Bump!!
14. Close this version issues
15. Close milestone
16. Close project
17. Generate HTML files
1. Run `otherfile/doc_to_html.bat`
2. Copy `doc_html` folder for the next steps
17. Update website
18. Update website
1. `git checkout gh-pages`
2. Update all version tags
1. `index.html`
Expand Down
5 changes: 4 additions & 1 deletion otherfile/version_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
FONT_LIST_ITEMS = ["### Version : {0}"]
PARAMS_ITEMS = ['ART_VERSION = "{0}"']
META_ITEMS = ['% set version = "{0}" %']
ISSUE_TEMPLATE_ITEMS = ["- Art {0}"]

FILES = {
"setup.py": SETUP_ITEMS,
Expand All @@ -38,7 +39,9 @@
os.path.join(
"art",
"art_param.py"): PARAMS_ITEMS,
os.path.join("otherfile", "meta.yaml"): META_ITEMS}
os.path.join("otherfile", "meta.yaml"): META_ITEMS,
os.path.join(".github", "ISSUE_TEMPLATE", "bug_report.yml"): ISSUE_TEMPLATE_ITEMS,
}

TEST_NUMBER = len(FILES) + 1

Expand Down
Loading