From 8bead3d2252c7c7b0f3fd25009ac152736b78568 Mon Sep 17 00:00:00 2001 From: "Colin S." <19342760+colinscz@users.noreply.github.com> Date: Mon, 16 Feb 2026 13:52:25 +0100 Subject: [PATCH 1/6] chore: create pull request template for contributions --- .github/PULL_REQUEST_TEMPLATE.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..7e721cc63 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +### 🔗 Linked issue + + + +### 📚 Description + + + + + + From a81b57eb61a57fb08c34d6b32063ef903d62c486 Mon Sep 17 00:00:00 2001 From: "Colin S." <19342760+colinscz@users.noreply.github.com> Date: Mon, 16 Feb 2026 13:56:09 +0100 Subject: [PATCH 2/6] chore: create feature request issue template Added a feature request template to streamline suggestions for feature requests. --- .github/ISSUE_TEMPLATE/feature-request.yml | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..022de389c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,36 @@ +name: "🚀 Feature request" +description: Suggest a feature that will improve Npmx +labels: ["pending triage"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! + + Please carefully read the contribution docs before suggesting a new feature + 👉 https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition to Npmx, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. + placeholder: Feature description + validations: + required: true + - type: checkboxes + id: additional-info + attributes: + label: Additional information + description: Additional information that helps us decide how to proceed. + options: + - label: Would you be willing to help implement this feature? + - type: checkboxes + id: required-info + attributes: + label: Final checks + description: Before submitting, please make sure you do the following + options: + - label: Read the [contribution guide](https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md). + required: true + - label: Check existing [issues](https://github.com/npmx-dev/npmx.dev/issues). + required: true From da780c9819116f1d1de0e5f23005d4973d1bf598 Mon Sep 17 00:00:00 2001 From: "Colin S." <19342760+colinscz@users.noreply.github.com> Date: Mon, 16 Feb 2026 14:01:59 +0100 Subject: [PATCH 3/6] chore: revise bug report template for Npmx --- .github/ISSUE_TEMPLATE/bug-report.yml | 28 +++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..dc542829b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,28 @@ +name: "\U0001F41E Bug report" +description: Create a report to help us improve Npmx +body: + - type: markdown + attributes: + value: | + Please carefully read the contribution docs before creating a bug report + 👉 https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: If applicable, add any other context about the problem here + - type: textarea + id: logs + attributes: + label: Logs + description: | + Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + render: shell-script From 678c47c5460d9749ddadda6301f12c15b9a789dd Mon Sep 17 00:00:00 2001 From: "Colin S." <19342760+colinscz@users.noreply.github.com> Date: Mon, 16 Feb 2026 14:03:04 +0100 Subject: [PATCH 4/6] chore: add issue template configuration for Npmx --- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..4c1540c6e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: 📚 Npmx Documentation + url: https://docs.npmx.dev/ + about: Check the documentation for usage of Npmx From 1b5e0859fbda6b5d5a7a92cbffc9e1ff2454530c Mon Sep 17 00:00:00 2001 From: "Colin S." <19342760+colinscz@users.noreply.github.com> Date: Mon, 16 Feb 2026 14:05:08 +0100 Subject: [PATCH 5/6] chore: Enhance PR template with context and tradeoffs section Added a section for additional context and tradeoffs. --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7e721cc63..a5f4aa91d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,6 +16,7 @@ Before creating the pull request, please make sure you do the following: - Ensure that PR title follows conventional commits (https://www.conventionalcommits.org) - Update the corresponding documentation if needed. - Include relevant tests that fail without this PR but pass with it. +- Add any additional context, tradeoffs, follow ups, or things reviewers should be aware of. Thank you for contributing to Npmx! -----------------------------------------------------------------------> From b1080f645318da7670597f81a2fd8dcc49855ed2 Mon Sep 17 00:00:00 2001 From: colinscz <19342760+colinscz@users.noreply.github.com> Date: Mon, 16 Feb 2026 14:35:01 +0100 Subject: [PATCH 6/6] chore: address review comments --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 8 ++++---- .github/PULL_REQUEST_TEMPLATE.md | 8 +++++++- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index dc542829b..b12e5c33f 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -24,5 +24,5 @@ body: attributes: label: Logs description: | - Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + Optional if you have reproduction steps. Please try not to insert an image but copy paste the log text. render: shell-script diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 022de389c..216f75757 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,14 +1,14 @@ -name: "🚀 Feature request" +name: '🚀 Feature request' description: Suggest a feature that will improve Npmx -labels: ["pending triage"] +labels: ['pending triage'] body: - type: markdown attributes: value: | Thank you for taking the time to fill out this feature request! - Please carefully read the contribution docs before suggesting a new feature - 👉 https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md + Please carefully read the contribution docs before suggesting a new feature + 👉 https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md - type: textarea id: feature-description attributes: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a5f4aa91d..221f31ed7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,6 +2,12 @@ +### 🧭 Context + + + + + ### 📚 Description @@ -16,7 +22,7 @@ Before creating the pull request, please make sure you do the following: - Ensure that PR title follows conventional commits (https://www.conventionalcommits.org) - Update the corresponding documentation if needed. - Include relevant tests that fail without this PR but pass with it. -- Add any additional context, tradeoffs, follow ups, or things reviewers should be aware of. +- Add any additional context, tradeoffs, follow-ups, or things reviewers should be aware of. Thank you for contributing to Npmx! ----------------------------------------------------------------------->