Skip to content

Commit

Permalink
fear: add issue templates (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
minikin authored Nov 10, 2023
1 parent 6a32bf1 commit 96ccade
Show file tree
Hide file tree
Showing 7 changed files with 306 additions and 8 deletions.
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/EPIC.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: "🏛️ Epic"
description: Create a new Epic.
title: "🏛️ [EPIC] : <title>"
labels: ["epic"]
projects: ["/input-output-hk/102"]

body:
- type: markdown
attributes:
value: "⚠️ **Epics are only to be created by the Project Managers!** ⚠️"

- type: input
id: summary
attributes:
label: "Summary"
description: "Short Summary of the Epic"
placeholder: "Short Summary"
validations:
required: true

- type: input
id: jira-epic
attributes:
label: "JIRA Epic"
description: All Epics must have a linked Jira [EPIC](https://input-output.atlassian.net/jira/software/c/projects/NPG/issues)
placeholder: ex. https://input-output.atlassian.net/browse/NPG-8294
validations:
required: true

- type: textarea
id: description
attributes:
label: "Description"
description: "Extended Description of the Epic"
placeholder: "Explicit extended description of the epic..."
validations:
required: true

- type: markdown
attributes:
value: |
---
## TODO Lists
- type: textarea
id: todo
attributes:
label: "Todo"
description: "Grouped Todo lists. Each links to its issue, when created."
placeholder: |
### <list 1 name>
- [ ] #1
- [ ] #2
- [ ] issue description when not yet created.
### <list 2 name>
- [ ] #3
- [ ] #4
- [ ] issue description when not yet created.
value: |
### <list 1 name>
- [ ] #1
- [ ] #2
- [ ] issue description when not yet created.
### <list 2 name>
- [ ] <issue>
- [ ] <issue>
- [ ] <issue>
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/TASK.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: "🛠️ Task"
description: |
Create a new Task.
Tasks document and manage specific to-dos, chores, or assignments within the project.
title: "🛠️ [TASK] : <title>"
labels: ["task"]
projects: ["/input-output-hk/102"]

body:
- type: markdown
attributes:
value: |
⚠️ **All Tasks must be listed as a Task in an Epic!** ⚠️
- type: input
id: summary
attributes:
label: "Summary"
description: "Short Summary of the Task"
placeholder: "Short Summary"
validations:
required: true

- type: textarea
id: description
attributes:
label: "Description"
description: "Extended Description of the Task"
placeholder: |
Explicit extended description of the task...
### Subtask List (Optional)
- [ ] #1
- [ ] Subtask placeholder waiting for an issue.
validations:
required: true
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false

- type: dropdown
id: OS
attributes:
label: What operating system are you seeing the problem on?
multiple: true
options:
- macOS
- Linux
- iOS
- Android
- Windows
- Other (specify in Anything else section)
validations:
required: true

- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Arc
- Other (specify in Anything else section)
- Not Applicable
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: sh

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
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: true
contact_links:
- name: Catalyst CI Discussions
url: https://github.com/input-output-hk/catalyst-ci/discussions
about: Please ask and answer questions here.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Feature Request
description: Suggest a new idea or enhancement for this project.
title: "[Feature]: "
labels: [enhancement]
projects: ["/input-output-hk/102"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: input
id: title
attributes:
label: Feature Title
description: Provide a clear and concise title for the feature.
placeholder: e.g., "New reporting functionality"
validations:
required: true

- type: textarea
id: description
attributes:
label: Feature Description
description: Provide a detailed description of the proposed feature.
placeholder: Describe the feature and its benefits.
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: Explain the use case of the proposed feature and how it would be used.
placeholder: Describe the use case.
validations:
required: true

- type: dropdown
id: existing-feature
attributes:
label: Is this a modification to an existing feature?
multiple: false
options:
- "Yes"
- "No"
validations:
required: true
39 changes: 39 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Description

Thanks for contributing to the project!
Please fill out this template to help us review your changes.

## Related Issue(s)

List the issue numbers related to this pull request.

> e.g., Closes #123, Resolves #456 Fixes #367
## Description of Changes

Provide a clear and concise description of what the pull request changes.

## Breaking Changes

Describe any breaking changes and the impact.

## Screenshots

If applicable, add screenshots to help explain your changes.

## Related Pull Requests

If applicable, list any related pull requests.

> e.g., #123, #456
## Please confirm the following checks

* [ ] My code follows the style guidelines of this project
* [ ] I have performed a self-review of my code
* [ ] I have commented my code, particularly in hard-to-understand areas
* [ ] I have made corresponding changes to the documentation
* [ ] My changes generate no new warnings
* [ ] I have added tests that prove my fix is effective or that my feature works
* [ ] New and existing unit tests pass locally with my changes
* [ ] Any dependent changes have been merged and published in downstream module
20 changes: 12 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/input-
### Your First Code Contribution

Embarking on your first code contribution can be an exhilarating yet intimidating endeavor.
Here at Catalyst Voices, we foster a welcoming and supportive environment to ensure
Here at Catalyst, we foster a welcoming and supportive environment to ensure
that everyone can contribute to the codebase irrespective of their experience level.
Below is a step-by-step guide to making your first code contribution to our repository:

Expand Down Expand Up @@ -186,7 +186,8 @@ Below is a step-by-step guide to making your first code contribution to our repo
* Verify that your changes don't break any existing functionality.

7. **Commit Your Changes**:
* Write a clear and concise commit message following the [Style guides](#style-guides) -> Commit Messages section guidelines.
* Write a clear and concise commit message following the
[Style guides](#style-guides) -> Commit Messages section guidelines.

8. **Push Your Changes**:
* Push your changes to your fork on GitHub.
Expand All @@ -204,15 +205,17 @@ Below is a step-by-step guide to making your first code contribution to our repo
* Once your pull request is approved, it will be merged into the main codebase.
* Celebrate your contribution and share it with the community!

Remember, every contributor was new at some point, and we are thrilled to welcome new members to our community.
Remember, every contributor was new at some point, and we are thrilled
to welcome new members to our community.
The journey of becoming an adept open-source contributor is rewarding and educational.
Your contribution, no matter how small, can make a significant impact.
Happy coding!

### Improving The Documentation

Documentation is a cornerstone of any successful open-source project.
It aids developers in understanding the purpose, structure, and functioning of the code, making the project accessible to all,
It aids developers in understanding the purpose, structure, and functioning of the code,
making the project accessible to all,
irrespective of their level of expertise.
Our project thrives on the contributions from the community,
and improving the documentation is one of the significant ways you can contribute.
Expand All @@ -229,7 +232,8 @@ contributing expanded explanations or new sections is highly encouraged.
If you have examples that illustrate the use of our code, we'd love to include them.
* **Consistency**: Ensure the documentation maintains a consistent style and tone.
Adhering to the style guidelines specified in our [Style guides](#style-guides) section is crucial.
* **Technical Accuracy**: Ensure that the documentation reflects the current state of the codebase and is technically accurate.
* **Technical Accuracy**: Ensure that the documentation reflects the current state
of the codebase and is technically accurate.

Your contributions should follow the guidelines specified in our [Style guides](#style-guides)
section to maintain high quality and consistency.
Expand Down Expand Up @@ -264,9 +268,9 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org) standa

Here's a brief overview of the Conventional Commits standard:

1. **Type**: The type of change being made (e.g., feat, fix, chore, docs, style, refactor, perf, test).
2. **Scope (Optional)**: The scope of the change, denoting what part of the codebase is being altered.
3. **Description**: A short, descriptive message of the change, written in the imperative mood.
**Type**: The type of change being made (e.g., feat, fix, chore, docs, style, refactor, perf, test).
**Scope (Optional)**: The scope of the change, denoting what part of the codebase is being altered.
**Description**: A short, descriptive message of the change, written in the imperative mood.

Format:

Expand Down

0 comments on commit 96ccade

Please sign in to comment.