Skip to content

Add issue templates #103

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.

Sign up for GitHub

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

Merged
arghyaxcodes merged 2 commits into from
Jan 17, 2022
Merged

Add issue templates #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b862dc
Create config.yml
arghyaxcodes Jan 17, 2022
4e27edc
Create documentation.yml
arghyaxcodes Jan 17, 2022
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
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Website
about: Visit the Javaistic website
url: https://javaistic.vercel.app/
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Documentation
description: Report problems and suggest ideas for the documentation
labels: [docs]

body:
- type: markdown
attributes:
value: >-
Before opening a new issue, make sure it isn't covered by an existing issue.
Please search for [issues with the `docs` label][docs-issues] (including
closed issues) before you continue.


[docs-issues]: https://github.com/javaistic/javaistic/issues?q=is%3Aissue+label%3Adocs+is%3Aopen

- type: dropdown
attributes:
label: Kind of Issue
description: >-
If your issue type is not here, select "other" and explain in the
"Description" field below.
options: [Improvement, Mistake, Other]
validations:
required: true

- type: textarea
attributes:
label: Description
description: |
Include as much detail as possible, for example:
- A (perma)link to the docs in question
- Suggestions for how to change the docs
placeholder: "Example: The documentation doesn't cover my use case of the NPM package..."
validations:
required: true

- type: dropdown
attributes:
label: Contributing
description: >-
This is an open source project and we welcome contributions. Do you want to
work on this issue?
options:
- 'Yes'
- 'No'
validations:
required: true