From 21c005dff288240134affc27e6eb86230fdaaad3 Mon Sep 17 00:00:00 2001 From: Andrew <46836330+andrewsgreene@users.noreply.github.com> Date: Fri, 25 Feb 2022 09:36:05 -0700 Subject: [PATCH] Update issue templates and contributing guide --- .github/ISSUE_TEMPLATE/bug_report.yml | 41 +---------------- .github/ISSUE_TEMPLATE/config.yml | 13 ------ .github/ISSUE_TEMPLATE/new_guide.yml | 10 +++++ .github/ISSUE_TEMPLATE/question.yml | 10 +++++ .github/PULL_REQUEST_TEMPLATE.md | 35 --------------- CONTRIBUTING.md | 64 ++++----------------------- 6 files changed, 30 insertions(+), 143 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/new_guide.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9f805581a..e73a94c4a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,24 +1,7 @@ name: 🐞 Report a bug -description: File a bug/issue on the core of Node-RED +description: File a bug/issue on Sparkles-Guide labels: [needs-triage] body: -- type: markdown - attributes: - value: | - This issue tracker is for problems with the Node-RED runtime, the editor or the core nodes. - - If your issue is: - - a general 'how-to' type question, - - a feature request or suggestion for a change, - - or problems with 3rd party (`node-red-contrib-`) nodes - - please use the [Node-RED Forum](https://discourse.nodered.org) or [slack team](https://nodered.org/slack). - - You could also consider asking a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/node-red) and tag it `node-red`. - - That way the whole Node-RED user community can help, rather than rely on the core development team. - - To help us understand the issue, please fill-in as much of the following information as you can: - type: textarea attributes: label: Current Behavior @@ -37,25 +20,3 @@ body: description: Steps to reproduce the behavior. validations: required: false -- type: textarea - attributes: - label: Example flow - description: If you have a minimal example flow that demonstrates the issue, share it here. - value: | - ``` - paste your flow here - ``` - validations: - required: false -- type: textarea - attributes: - label: Environment - description: Please tell us about your environment. Include any relevant information on how you are running Node-RED. - value: | - - Node-RED version: - - Node.js version: - - npm version: - - Platform/OS: - - Browser: - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 35dfde04b..0086358db 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,14 +1 @@ blank_issues_enabled: true -contact_links: - - name: ❓ Questions - url: https://discourse.nodered.org - about: Ask your question on the Node-RED forum - - name: ⭐️ Feature Request - url: https://discourse.nodered.org/c/development/feature-requests - about: Discuss your request with the community - - name: 🗂 Documentation - url: https://nodered.org/docs - about: Go straight to the documentation - - name: 💬 Slack - url: https://nodered.org/slack - about: Chat about the project on our slack team diff --git a/.github/ISSUE_TEMPLATE/new_guide.yml b/.github/ISSUE_TEMPLATE/new_guide.yml new file mode 100644 index 000000000..7ea6c4eeb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_guide.yml @@ -0,0 +1,10 @@ +name: Suggest a Guide +description: File a bug/issue on Sparkles-Guide +labels: [needs-triage, new-guide] +body: +- type: textarea + attributes: + label: New Guide + description: Describe the guide you are suggesting. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..bcbe67425 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,10 @@ +name: ? Question +description: Ask a question Sparkles-Guide +labels: [needs-triage, question] +body: +- type: textarea + attributes: + label: Question + description: Your question + validations: + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 320ec3dd7..000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,35 +0,0 @@ - - -- [ ] Bugfix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Improved node content - - - -## Proposed changes - - - -## Checklist - - -- [ ] I have read the [contribution guidelines](../docs/sparkles-guides-contribution.md) -- [ ] For non-bugfix PRs, I have discussed this change on the forum/slack team. -- [ ] I have run `cypress` to verify the tests pass -- [ ] I have added suitable tests to cover the new/changed functionality diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95287d81f..6fc1da356 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,62 +1,16 @@ -# Contributing to Node-RED +# Contributing to Sparkles Guide -We welcome contributions, but request you follow these guidelines. +Submit an [issue](https://github.com/defenseunicorns/Sparkles-Guide/issues/new) if unsure. - - [Raising issues](#raising-issues) - - [Feature requests](#feature-requests) - - [Pull-Requests](#pull-requests) - - [Contributor License Agreement](#contributor-license-agreement) +### To Sparkle Guides -This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/). -By participating, you are expected to uphold this code. Please report unacceptable -behavior to the project's core team at team@nodered.org. +See [this](docs/sparkles-guides-contribution.md) guide, if you are looking to contribute to the guides and flows. -## Raising issues +### To Code -Please raise any bug reports on the relevant project's issue tracker. Be sure to -search the list to see if your issue has already been raised. +See [this](docs/code-contribution.md) guide, if you are looking to add/remove/modify code implementing Sparkle's Guide. -A good bug report is one that make it easy for us to understand what you were -trying to do and what went wrong. +## Copyright and license -Provide as much context as possible so we can try to recreate the issue. -If possible, include the relevant part of your flow. To do this, select the -relevant nodes, press Ctrl-E and copy the flow data from the Export dialog. - -At a minimum, please include: - - - Version of Node-RED - either release number if you downloaded a zip, or the first few lines of `git log` if you are cloning the repository directly. - - Version of Node.js - what does `node -v` say? - -## Feature requests - -For feature requests, please raise them on the [forum](https://discourse.nodered.org). - -## Pull-Requests - -If you want to raise a pull-request with a new feature, or a refactoring -of existing code, it may well get rejected if you haven't discussed it on -the [forum](https://discourse.nodered.org) first. - -All contributors need to sign the OpenJS Foundation's Contributor License Agreement. -It is an online process and quick to do. If you raise a pull-request without -having signed the CLA, you will be prompted to do so automatically. - - -### Code Branches - -When raising a PR for a fix or a new feature, it is important to target the right branch. - - - `master` - this is the main branch for the latest stable release of Node-RED. All bug fixes for that release should target this branch. - - `v1.x` - this is the maintenance branch for the 1.x stream. If a fix *only* applies to 1.x, then it should target this branch. If it applies to the current stable release as well, target `master` first. We will then decide if it needs to be back ported to the 1.x stream. - - `dev` - this is the branch for new feature development targeting the next milestone release. - -### Coding standards - -Please ensure you follow the coding standards used through-out the existing -code base. Some basic rules include: - - - all files must have the Apache license in the header. - - indent with 4-spaces, no tabs. No arguments. - - opening brace on same line as `if`/`for`/`function` and so on, closing brace - on its own line. +Copyright OpenJS Foundation and other contributors, https://openjsf.org under [the Apache 2.0 license](LICENSE). +December 2021 --- this project and modifications within it are a derivative work of [node-red](https://github.com/node-red/node-red) \ No newline at end of file