From 83262226032cbf2246ad20360b2bababdd73258e Mon Sep 17 00:00:00 2001 From: Atila Fassina Date: Mon, 27 Jan 2025 12:01:18 +0100 Subject: [PATCH 1/3] update the contributing templates and links --- .github/ISSUE_TEMPLATE/bug.yml | 15 ++++++++------- .github/ISSUE_TEMPLATE/config.yml | 1 - .github/ISSUE_TEMPLATE/feature.yml | 23 ++++++++++++++--------- .github/ISSUE_TEMPLATE/question.yml | 7 ++++--- package.json | 2 +- 5 files changed, 27 insertions(+), 21 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index fed2b1c46..9511cea71 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,7 +1,7 @@ name: Bug report 🐛 -description: Create a bug report for Solid Start. -labels: ['bug', 'needs triage'] -title: '[Bug?]: ' +description: Create a bug report for SolidStart. +labels: ["bug", "needs triage"] +title: "[Bug?]: " body: - type: markdown attributes: @@ -59,9 +59,10 @@ body: OS: Linux 5.10 Debian GNU/Linux 9 (stretch) CPU: (8) arm64 Binaries: - Node: 14.17.0 - /usr/local/bin/node - Yarn: 1.22.5 - /usr/local/bin/yarn - npm: 6.14.13 - /usr/local/bin/npm + Node: 20.0.0 - /usr/local/bin/node + Yarn: 3.0.0 - /usr/local/bin/yarn + npm: 9.8.0 - /usr/local/bin/npm + pnpm: 9.0.0 - /usr/local/bin/pnpm npmPackages: - solid-start: 1.0.0 => 1.0.0 + @solidjs/start: 1.0.0 => 1.0.0 render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 3ba13e0ce..000000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index b282bcee7..2198d4e2e 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,14 +1,8 @@ name: Feature request 💄 -description: Suggest a new idea for Solid Start. -labels: ['enhancement', 'needs triage'] -title: '[Feature?]: ' +description: Suggest a new idea for SolidStart. +labels: ["enhancement", "needs triage"] +title: "[Feature?]: " body: - - type: markdown - attributes: - value: | - Please provide a searchable summary of the issue in the title above ⬆️. - - Thanks for contributing by creating an issue! ❤️ - type: checkboxes attributes: label: Duplicates @@ -16,6 +10,7 @@ body: options: - label: I have searched the existing issues required: true + - type: checkboxes attributes: label: Latest version @@ -23,14 +18,24 @@ body: options: - label: I have tested the latest version required: true + + - type: markdown + attributes: + value: | + Please provide a searchable summary of the issue in the title above ⬆️. + + Thanks for contributing by creating an issue! ❤️ + - type: textarea attributes: label: Summary 💡 description: Describe how it should work. + - type: textarea attributes: label: Examples 🌈 description: Provide a link to the Solid Start specification, other implementations, or screenshots of the expected behavior. + - type: textarea attributes: label: Motivation 🔦 diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 085befea7..10fa00688 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,7 +1,7 @@ -name: 'Questions / Help 💬' +name: "Questions / Help 💬" description: If you have questions, please check the Discussions tab -title: '[Please read the message below]' -labels: [':speech_balloon: Question'] +title: "[Please read the message below]" +labels: [":speech_balloon: Question"] body: - type: markdown attributes: @@ -14,6 +14,7 @@ body: - [The Discussion Q&A page](https://github.com/solidjs/solid-start/discussions/categories/q-a) - [All Discussions](https://github.com/solidjs/solid-start/discussions) + - [SolidJS Discord](https://discord.gg/solidjs) - type: checkboxes id: no-post attributes: diff --git a/package.json b/package.json index 4760ea0ff..76a62c431 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "license": "MIT", "repository": { "type": "git", - "url": "https://github.com/ryansolid/solid-start" + "url": "https://github.com/solidjs/solid-start" }, "private": true, "scripts": { From 94f52e26e3da14e72e545a40402e5019718d8b4e Mon Sep 17 00:00:00 2001 From: Atila Fassina Date: Mon, 27 Jan 2025 12:09:21 +0100 Subject: [PATCH 2/3] add `SECURITY.md` --- .github/SECURITY.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/SECURITY.md diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 000000000..9d5ef9478 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,25 @@ +Thanks for helping make Solid safe for everyone. + +# Security + +SolidJS takes the security of our software seriously, including all of the open-source code repositories managed through [this GitHub organization](https://github.com/solidjs). + +## Reporting a Vulnerability + +**If you think you've found a security issue, please DO NOT report, discuss, or describe it on Discord or GitHub.** + +**All security-related issues, concerns, and problems must be reported via email to: security@solidjs.com** + +Please include everything necessary to reproduce the problem when sending over information, including an example repository on StackBlitz or GitHub. Please don't add explicit details about the security issue you are reporting in any of the repository's contents. + +**_This is detrimental to the safety of all SolidStart users. No exceptions._** + +## Embargo Policy + +SolidJS's Security Team members must share information only within the Solid Core and Security teams on a need-to-know basis to fix the related issue in Solid. The information members and others receive thorough participation in this group must not be made public, shared, or even hinted otherwise, except with prior explicit approval (which shall be handled on a case-by-case basis). This holds true until the agreed-upon public disclosure date/time is satisfied. + +As a clarifying example, this policy forbids Solid Security members from sharing list information with their employers; unless prior arrangements have been made directly with an employer. + +In the unfortunate event that you share the information beyond what is allowed by this policy, you must urgently inform the Solid Security Team of exactly what information leaked and to whom, as well as the steps that will be taken to prevent future leaks. + +**Repeated offenses may lead to the removal from the Security or Solid team.** From 29510e9ee746ac6eedc8af88d7626561543567aa Mon Sep 17 00:00:00 2001 From: Atila Fassina Date: Mon, 27 Jan 2025 12:19:26 +0100 Subject: [PATCH 3/3] hardcode issue template order / update PR template --- .github/ISSUE_TEMPLATE.md | 9 +++++++++ .../ISSUE_TEMPLATE/{bug.yml => 01-bug.yml} | 0 .../{feature.yml => 02-feature.yml} | 0 .../{question.yml => 03-question.yml} | 0 .github/ISSUE_TEMPLATE/config.yml | 4 ++++ .github/PULL_REQUEST_TEMPLATE.md | 19 +++---------------- 6 files changed, 16 insertions(+), 16 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md rename .github/ISSUE_TEMPLATE/{bug.yml => 01-bug.yml} (100%) rename .github/ISSUE_TEMPLATE/{feature.yml => 02-feature.yml} (100%) rename .github/ISSUE_TEMPLATE/{question.yml => 03-question.yml} (100%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..e9c06c805 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,9 @@ + + + + + + +## Overview + +... diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/bug.yml rename to .github/ISSUE_TEMPLATE/01-bug.yml diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/02-feature.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/feature.yml rename to .github/ISSUE_TEMPLATE/02-feature.yml diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/03-question.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/question.yml rename to .github/ISSUE_TEMPLATE/03-question.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..aea628d95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: "SolidJS Discord" + url: https://discord.gg/solidjs + about: For questions and suggestions, please joins us on discord! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cfa287213..f80cd347f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,28 +2,15 @@ Please check if your PR fulfills the following requirements: +- [ ] Addresses an existing open issue: fixes #000 - [ ] Tests for the changes have been added (for bug fixes / features) -## PR Type - -What kind of change does this PR introduce? - - - -- [ ] Bugfix -- [ ] Feature -- [ ] Code style update (formatting, local variables) -- [ ] Refactoring (no functional changes, no api changes) -- [ ] Build related changes -- [ ] CI related changes -- [ ] Documentation content changes -- [ ] infrastructure changes -- [ ] Other... Please describe: - ## What is the current behavior? + ## What is the new behavior? ## Other information +