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

feat: issue templates #295

Merged
merged 6 commits into from
Jul 13, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: 🐛 Bug Report
description: Create a bug report to help us improve Nixpacks.
title: ""
labels: ["bug"]
body:
- type: checkboxes
id: issue-already-exists
attributes:
label: Is there an existing issue for this?
description: |
Please search to see if an issue already exists for the bug you encountered.
Please see [Searching Issues and Pull Requests](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests) for how to use the GitHub search bar and filters.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: describe-the-bugs
validations:
required: true
attributes:
label: Describe the bug
description: Please provide a clear and concise description about the problem you ran into.
placeholder: This happened when I...
- type: textarea
id: to-reproduce
validations:
required: false
attributes:
label: To reproduce
description: |
Please provide a code sample or a code snippet to reproduce the said problem. If you have code snippets, error messages or a stack trace please provide them here.
placeholder: |
Steps to reproduce the bug:

1. Provide '...'
2. Run '...'
3. See error
- type: textarea
id: expected-behavior
validations:
required: false
attributes:
label: Expected behavior
description: "A clear and concise description of what you would expect to happen."
- type: textarea
id: environment-info
attributes:
label: Environment
description: |
Please share your environment with us. (ie, OS, OS version and Nixpacks version)
validations:
required: true
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
blank_issues_enabled: true
version: 2.1
contact_links:
- name: Nixpacks' documentation
url: https://nixpacks.com/
about: Documentation about Nixpacks.
- name: Railway.
url: https://railway.app/
about: Railway.
- name: Nixpacks' issue tracker
aarnphm marked this conversation as resolved.
Show resolved Hide resolved
url: https://github.com/railwayapp/nixpacks/issues
about: For creating issues/PR ticket for Nixpacks' development.
aarnphm marked this conversation as resolved.
Show resolved Hide resolved
- name: Railway's Discord
url: discord.gg/railway
about: Contact the Railway team for support via Discord.
- name: Railway Blog
aarnphm marked this conversation as resolved.
Show resolved Hide resolved
url: https://blog.railway.app/
about: To get the latest news/updates from the Railway team.
aarnphm marked this conversation as resolved.
Show resolved Hide resolved

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: 🚀 Feature Request
description: Submit a proposal/request for new Nixpacks feature.
title: ""
body:
- type: textarea
id: feature-request
validations:
required: true
attributes:
label: Feature request
description: |
A clear and concise description of the feature request.
placeholder: |
An implementation could be implemented by...
aarnphm marked this conversation as resolved.
Show resolved Hide resolved
- type: textarea
id: motivation
validations:
required: false
attributes:
label: Motivation
description: |
Please outline the motivation for this feature request. Is your feature request related to a problem? e.g., I'm always frustrated when [...].
If this is related to another issue, please link here too.
If you have a current workaround, please also provide it here.
placeholder: |
This feature would solve ...
- type: textarea
id: contribution
attributes:
label: Contribution
description: |
Is there any way that you could help, e.g. by submitting a PR? Please make sure to read the [contributing guidelines](https://github.com/railwayapp/nixpacks/blob/main/CONTRIBUTING.md).
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## What does this PR address?
<!-- Thanks for sending a pull request! -->

<!-- Remove if not applicable -->
Fixes # (issue)

## Before submitting:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask -->
<!--- If you plan to update documentation or tests in follow-up, please note -->

- [ ] Make sure to follow [GitHub's guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) on creating PR.
- [ ] Did you read through [contribution guidelines](https://github.com/railwayapp/nixpacks/blob/main/CONTRIBUTING.md)?
- [ ] Did your changes require updates to the documentation? Have you updated those accordingly?
- [ ] Did you write tests to cover your changes? Did it pass locally when running `cargo test`?
- [ ] Did you run `cargo fmt`, `cargo check` and `cargo clippy` locally to ensure that CI pass?
aarnphm marked this conversation as resolved.
Show resolved Hide resolved
aarnphm marked this conversation as resolved.
Show resolved Hide resolved
aarnphm marked this conversation as resolved.
Show resolved Hide resolved