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

New issue templates #89

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Issue Template
about: Contribute to Periodum by creating an issue.
title: ''
name: Bug Report Template
about: Contribute to Periodum by creating a bug report issue.
title: 'Bug: '
labels: bug
assignees: ''

Expand Down
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Documentation Issue Template
about: Contribute to Periodum by reporting an issue on our documentation.
title: 'Documentation: '
labels: documentation
assignees: ''

---

- **Issue Title**: Write a short title to describe the issue. Correct example: *Typo on README.md*

- **Description**: Describe the details of the issue with a few sentences, give your opinions on what may be causing the issue, what solutions you tried and any recommendations for a solution. If the title is clear enough, you may skip this portion. The shorter and more concise you are the better.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/false_info_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: False Info Template
about: Contribute to Periodum by letting us know the false info given on our side.
title: 'False Info: '
labels: false info
assignees: ''

---

- **Issue Title**: Write a short title to describe the false info. Correct example: *Some mass numbers are wrong*

- **Description**: Describe the details of the false info with a few sentences. If the title is clear enough, you may skip this portion. The shorter and more concise you are the better.

- **True info vs. Given info**: Please enter the true info and the info that is given by Periodum. If there are so many false info of the same type, you can give the most obvious examples. For example:
- ***True info**: Protium's mass is 1.007825 amu*
- ***Given info**: Protium's mass is 1 amu*

- **Screen Shot/Video**: For us to investigate this situation better, please include a screenshot or recording.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature Template
about: Contribute to Periodum with new feature ideas.
title: 'Feature: '
labels: enhancement
assignees: ''

---

- **Title**: Write a short title to describe your idea. Correct example: *Common Compound Examples*

- **Description**: Describe the details of your idea with a few sentences.

- **Things to Change**: Things to change for your idea to work.

- **Pros vs. Cons**: Please enter the expected pros and cons of your idea. For example:
- ***Pros**: Access to compounds that include the selected element will be easier and with that user experience will slightly improve.*
- ***Cons**: No cons may accour as far as I think.*