From 3676fa97ad9dc647cadfa4a3db8625212e5c5af2 Mon Sep 17 00:00:00 2001 From: Aaron Pham <29749331+aarnphm@users.noreply.github.com> Date: Mon, 11 Jul 2022 15:42:58 -0700 Subject: [PATCH 1/6] feat: issue templates Signed-off-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 54 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 15 ++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 41 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 22 +++++++++ 4 files changed, 132 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..50260d18c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,54 @@ +name: 🐛 Bug Report +description: Create a report to help us improve Nixpacks. +title: "bug: " +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 Request](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: I ran into ... while using ... + - type: textarea + id: to-reproduce + validations: + required: false + attributes: + label: To reproduce + description: | + Please provide a code sample or a code snipet to reproduce said problem. If you have code snippets, error messages, stack trace please also provide them here. + + **IMPORTANT**: make sure to use [code tag](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) to correctly format your code. Screenshot is helpful but don't use it for code snippets as it doesn't allow others to copy-and-paste your code. + placeholder: | + Steps to reproduce the behaviour: + + 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. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..72587bda1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,15 @@ +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 + url: https://github.com/railwayapp/nixpacks/issues + about: For creating issues/PR ticket for Nixpacks' development + - name: Railway Support + url: help@railway.app + about: Contact the Railway team for support diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..e44432177 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,41 @@ +name: 🚀 Feature Request +description: Submit a proposal/request for new Nixpacks feature. +title: "feature: " +body: +- type: textarea + id: feature-request + validations: + required: true + attributes: + label: Feature request + description: | + A clear and concise description of the feature proposal. + placeholder: | + An implementation of ... can be done as follow: +- type: textarea + id: motivation + validations: + required: false + attributes: + label: Motivation + description: | + Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. + If this is related to another GitHub issue, please link here too. + If you have a current workaround, please also provide it here. + placeholder: | + This feature would solve issue ... +- type: checkboxes + 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.md](https://github.com/railwayapp/nixpacks/blob/main/CONTRIBUTING.md). + options: + - label: I can contribute code. + required: false + - label: I can contribute documentation. + required: false + - label: I can help testing the feature. + required: false + - label: I will be open to provide feedback once the feature is released. + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..d346b535a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +## What does this PR address? + + + +Fixes # (issue) + +## Before submitting: + + + + +- [ ] 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)? +- [ ] Can you build the project with `cargo build` and run the example with `cargo run --build examples/node --name node`? +- [ ] 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 check` and `cargo clippy` locally to ensure that CI pass? + +## Who can help review? + +Feel free to tag members/contributors who can help review your PR. + From b5d53a2277a19ed567a0b152efdb3a70ddbf2a32 Mon Sep 17 00:00:00 2001 From: Aaron Pham <29749331+aarnphm@users.noreply.github.com> Date: Mon, 11 Jul 2022 16:08:19 -0700 Subject: [PATCH 2/6] chore: address changes Signed-off-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 16 +++++++-------- .github/ISSUE_TEMPLATE/config.yml | 16 +++++++++------ .github/ISSUE_TEMPLATE/feature_request.yml | 23 +++++++--------------- .github/PULL_REQUEST_TEMPLATE.md | 3 +-- 4 files changed, 25 insertions(+), 33 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 50260d18c..0b82eefd9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ name: 🐛 Bug Report -description: Create a report to help us improve Nixpacks. -title: "bug: " +description: Create a bug report to help us improve Nixpacks. +title: "" labels: ["bug"] body: - type: checkboxes @@ -9,7 +9,7 @@ body: 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 Request](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. + 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 @@ -20,7 +20,7 @@ body: attributes: label: Describe the bug description: Please provide a clear and concise description about the problem you ran into. - placeholder: I ran into ... while using ... + placeholder: This happened when I... - type: textarea id: to-reproduce validations: @@ -28,11 +28,9 @@ body: attributes: label: To reproduce description: | - Please provide a code sample or a code snipet to reproduce said problem. If you have code snippets, error messages, stack trace please also provide them here. - - **IMPORTANT**: make sure to use [code tag](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) to correctly format your code. Screenshot is helpful but don't use it for code snippets as it doesn't allow others to copy-and-paste your code. + 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 behaviour: + Steps to reproduce the bug: 1. Provide '...' 2. Run '...' @@ -49,6 +47,6 @@ body: attributes: label: Environment description: | - Please share your environment with us. + Please share your environment with us. (ie, OS, OS version and Nixpacks version) validations: required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 72587bda1..288238407 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,12 +4,16 @@ contact_links: - name: Nixpacks' documentation url: https://nixpacks.com/ about: Documentation about Nixpacks. - - name: Railway + - name: Railway. url: https://railway.app/ - about: Railway + about: Railway. - name: Nixpacks' issue tracker url: https://github.com/railwayapp/nixpacks/issues - about: For creating issues/PR ticket for Nixpacks' development - - name: Railway Support - url: help@railway.app - about: Contact the Railway team for support + about: For creating issues/PR ticket for Nixpacks' development. + - name: Railway's Discord + url: discord.gg/railway + about: Contact the Railway team for support via Discord. + - name: Railway Blog + url: https://blog.railway.app/ + about: To get the latest news/updates from the Railway team. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index e44432177..3e8867733 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -9,9 +9,9 @@ body: attributes: label: Feature request description: | - A clear and concise description of the feature proposal. + A clear and concise description of the feature request. placeholder: | - An implementation of ... can be done as follow: + An implementation could be implemented by... - type: textarea id: motivation validations: @@ -19,23 +19,14 @@ body: attributes: label: Motivation description: | - Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. - If this is related to another GitHub issue, please link here too. + 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 issue ... -- type: checkboxes + 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.md](https://github.com/railwayapp/nixpacks/blob/main/CONTRIBUTING.md). - options: - - label: I can contribute code. - required: false - - label: I can contribute documentation. - required: false - - label: I can help testing the feature. - required: false - - label: I will be open to provide feedback once the feature is released. - required: false + 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). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d346b535a..daf8a9d80 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,10 +11,9 @@ Fixes # (issue) - [ ] 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)? -- [ ] Can you build the project with `cargo build` and run the example with `cargo run --build examples/node --name node`? - [ ] 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 check` and `cargo clippy` locally to ensure that CI pass? +- [ ] Did you run `cargo fmt`, `cargo check` and `cargo clippy` locally to ensure that CI pass? ## Who can help review? From 38f13b2512bf32ff136a2c9a47cd94723a69995a Mon Sep 17 00:00:00 2001 From: Aaron Pham <29749331+aarnphm@users.noreply.github.com> Date: Mon, 11 Jul 2022 16:43:01 -0700 Subject: [PATCH 3/6] chore: updates Signed-off-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 5 ----- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 3e8867733..49111c7e0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: 🚀 Feature Request description: Submit a proposal/request for new Nixpacks feature. -title: "feature: " +title: "" body: - type: textarea id: feature-request diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index daf8a9d80..1ba48645f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,8 +14,3 @@ Fixes # (issue) - [ ] 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? - -## Who can help review? - -Feel free to tag members/contributors who can help review your PR. - From ed1670045a5f728df3c58559c648552da7b549ac Mon Sep 17 00:00:00 2001 From: Aaron Pham <29749331+aarnphm@users.noreply.github.com> Date: Mon, 11 Jul 2022 19:46:15 -0400 Subject: [PATCH 4/6] chore: Apply suggestions from code review --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1ba48645f..1ccc6be9e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,4 +13,4 @@ Fixes # (issue) - [ ] 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? +- [ ] Have you run `cargo fmt`, `cargo check` and `cargo clippy` locally to ensure that CI pass? From 3cd22ee2331deeb5a4d515fc7f890369d35c25b1 Mon Sep 17 00:00:00 2001 From: Aaron Pham <29749331+aarnphm@users.noreply.github.com> Date: Mon, 11 Jul 2022 19:50:47 -0400 Subject: [PATCH 5/6] chore: Apply suggestions from code review --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1ccc6be9e..038be7931 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,4 +13,4 @@ Fixes # (issue) - [ ] 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`? -- [ ] Have you run `cargo fmt`, `cargo check` and `cargo clippy` locally to ensure that CI pass? +- [ ] Have you run `cargo fmt`, `cargo check` and `cargo clippy` locally to ensure that CI passes? From 869cd07fed9fe8a1642404dae0b544492feb8f25 Mon Sep 17 00:00:00 2001 From: Aaron Pham <29749331+aarnphm@users.noreply.github.com> Date: Tue, 12 Jul 2022 03:53:27 -0400 Subject: [PATCH 6/6] chore: Apply suggestions from code review Co-authored-by: Milo <50248166+Milo123459@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/config.yml | 6 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 2 files changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 288238407..c4fd42f93 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -7,13 +7,7 @@ contact_links: - name: Railway. url: https://railway.app/ about: Railway. - - name: Nixpacks' issue tracker - url: https://github.com/railwayapp/nixpacks/issues - about: For creating issues/PR ticket for Nixpacks' development. - name: Railway's Discord url: discord.gg/railway about: Contact the Railway team for support via Discord. - - name: Railway Blog - url: https://blog.railway.app/ - about: To get the latest news/updates from the Railway team. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 49111c7e0..6cf1060c6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -11,7 +11,7 @@ body: description: | A clear and concise description of the feature request. placeholder: | - An implementation could be implemented by... + This could be implemented by... - type: textarea id: motivation validations: