-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Improve README, and create issue and PR templates (#1)
- Improve formatting of README file - Create templates for issues and PR
- Loading branch information
Showing
7 changed files
with
153 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Code Owners | ||
|
||
# Root | ||
* @skarllot |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
name: 🐞 Bug report | ||
description: Something not behaving as expected? | ||
title: '[Bug]: ' | ||
labels: ['bug'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please check for an existing issue before submitting a bug report. | ||
- type: textarea | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: A clear and concise description of what you expected to happen. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Actual behavior | ||
description: What actually happens. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Steps to reproduce | ||
description: | | ||
Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small project, with steps to run it. | ||
Always include text as text rather than screenshots so code can easily be copied and will show up in searches. | ||
Stack Overflow has a great article about [how to create a minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Exception(s) (if any) | ||
description: Include any exception(s) and stack trace(s) you get when facing this issue. | ||
placeholder: | ||
validations: | ||
required: false | ||
- type: input | ||
attributes: | ||
label: Program version | ||
description: | | ||
Which version of FlowPair are you facing the issue with? | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Anything else? | ||
description: | | ||
Links? References? Anything that will give us more context about the issue you are encountering is useful. | ||
💡Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
name: 💡 Feature request | ||
description: Suggest a feature request or improvement | ||
title: '[Feature request]: ' | ||
labels: ['feature suggestion'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please check for an existing issue before submitting a feature request. | ||
- type: textarea | ||
attributes: | ||
label: Is your feature request related to a specific problem? Or an existing feature? | ||
description: A clear and concise description of what the problem is. Motivating examples help us prioritize things. | ||
placeholder: I am trying to do [...] but [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe the solution you'd like | ||
description: | | ||
A clear and concise description of what you want to happen. Include any alternative solutions you've considered. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: | | ||
Add any other context or screenshots about the feature request here. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: 🤔 Question? | ||
description: You have something specific to achieve and the existing documentation hasn't covered how. | ||
title: '[Question]: ' | ||
labels: ['question'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please check for an existing issue before asking a question. | ||
Also consider asking your question on [Github Discussions](https://github.com/skarllot/flow-pair/discussions) instead. | ||
- type: textarea | ||
attributes: | ||
label: What are you wanting to achieve? | ||
description: A clear and concise description of what you're trying to do. | ||
placeholder: I am trying to do [...] but [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: What code or approach do you have so far? | ||
description: | | ||
We ❤ code! Point us to a [minimalistic project which shows what you have so far](https://stackoverflow.com/help/mcve) hosted in a public GitHub repository. | ||
Code snippets wrapped in a codefence are also acceptable. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: | | ||
Add any other context or screenshots related to your question here. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: 💬 Ask on Github Discussions | ||
url: https://github.com/skarllot/flow-pair/discussions | ||
about: The best place for asking general purpose questions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
<!-- Thank you for contributing to FlowPair! Open source is only as strong as its contributors. --> | ||
|
||
# Pull Request | ||
|
||
## The issue or feature being addressed | ||
|
||
<!-- Please include the existing GitHub issue number where relevant --> | ||
|
||
## Details on the issue fix or feature implementation | ||
|
||
## Confirm the following | ||
|
||
- [ ] I started this PR by branching from the head of the default branch | ||
- [ ] I have targeted the PR to merge into the default branch | ||
- [ ] I have included unit tests for the issue/feature | ||
- [ ] I have successfully run a local build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters