fix #11 - Governance, contribution, templates#13
fix #11 - Governance, contribution, templates#13ricardozanini wants to merge 5 commits intoserverlessworkflow:mainfrom
Conversation
Signed-off-by: Ricardo Zanini <ricardozanini@gmail.com>
There was a problem hiding this comment.
Pull request overview
Adds foundational governance, contribution, and community process documentation for the Serverless Workflow Editor repository, aligning with Issue #11’s goal of improving onboarding and project management clarity.
Changes:
- Adds top-level governance, contributing, and code of conduct documents (with links to CNCF/parent project policies).
- Introduces GitHub Issue Forms templates (bug report, feature request, question) and disables blank issues.
- Adds a support contact link directing users to the project’s Slack channel.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
GOVERNANCE.md |
Adds governance pointer to the parent specification repo and a community support link. |
CONTRIBUTING.md |
Adds contribution workflow guidance plus (currently non-actionable) local build/dev instructions. |
CODE_OF_CONDUCT.md |
Adds CNCF Code of Conduct reference and reporting instructions (includes an unresolved TODO block). |
.github/ISSUE_TEMPLATE/config.yml |
Disables blank issues and adds a Slack contact link. |
.github/ISSUE_TEMPLATE/bug_report.yml |
Adds structured bug report form. |
.github/ISSUE_TEMPLATE/feature_request.yml |
Adds structured feature request form with DoD checklist. |
.github/ISSUE_TEMPLATE/question.yml |
Adds structured question/general feedback form. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JBBianchi
left a comment
There was a problem hiding this comment.
I think it's a good base, thanks ric!
Co-authored-by: Jean-Baptiste Bianchi <72747835+JBBianchi@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
fantonangeli
left a comment
There was a problem hiding this comment.
@ricardozanini LGTM, Thanks for this PR.
I left a few suggestion, but not required.
There was a problem hiding this comment.
Should we add a section for the expected result/behaviour?
Co-authored-by: Fabrizio Antonangeli <fabrizio.antonangeli@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Prerequisites | ||
|
|
||
| To build and run the editor locally, you will need: | ||
| - **Node.js** (v24.x or higher) |
There was a problem hiding this comment.
The Node.js prerequisite is very specific, but the repo currently doesn’t define an expected Node version anywhere (no package.json with engines, .nvmrc, etc.). To avoid misleading contributors, either add a single source of truth for the Node version (and reference it here) or change this to a less specific requirement (e.g., “current LTS”).
| - **Node.js** (v24.x or higher) | |
| - **Node.js** (current LTS version; see https://nodejs.org/) |
| The project is structured as a monorepo to support multiple distribution targets (Web, VS Code, etc.) as defined in our architectural decisions. | ||
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/serverlessworkflow/editor.git | ||
| cd editor | ||
|
|
||
| # Install dependencies | ||
| npm install | ||
|
|
||
| # Build all packages in the monorepo | ||
| npm run build | ||
| ``` | ||
|
|
There was a problem hiding this comment.
These build instructions assume a JS/TS monorepo with a root package.json and an npm run build script, but this repository currently contains only documentation files (no package.json). Please either add the missing project scaffolding/scripts or adjust this section to match the current repo state (e.g., mark build steps as TBD).
| The project is structured as a monorepo to support multiple distribution targets (Web, VS Code, etc.) as defined in our architectural decisions. | |
| ```bash | |
| # Clone the repository | |
| git clone https://github.com/serverlessworkflow/editor.git | |
| cd editor | |
| # Install dependencies | |
| npm install | |
| # Build all packages in the monorepo | |
| npm run build | |
| ``` | |
| This repository currently contains documentation content only and does not define a Node.js project (there is no root `package.json`). | |
| As a result, there is no build step required at this time. When implementation code is added to this repository in the future, this section will be updated with the appropriate setup and build instructions (TBD). |
| We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). | ||
|
|
||
|
|
||
| Please contact the [CNCF Code of Conduct Committee](mailto:conduct@cncf.io) | ||
| in order to report violations of the Code of Conduct. |
There was a problem hiding this comment.
Minor punctuation/formatting: there’s an extra blank line, and the “Please contact…” sentence doesn’t end with a period. Consider collapsing to a single paragraph and ending the sentence cleanly.
| We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). | |
| Please contact the [CNCF Code of Conduct Committee](mailto:conduct@cncf.io) | |
| in order to report violations of the Code of Conduct. | |
| We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). Please contact the [CNCF Code of Conduct Committee](mailto:conduct@cncf.io) in order to report violations of the Code of Conduct. |
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: Step to reproduce |
There was a problem hiding this comment.
Grammar: the label reads “Step to reproduce” but the description/placeholder describe multiple steps. Consider changing the label to “Steps to reproduce”.
| label: Step to reproduce | |
| label: Steps to reproduce |
Closes #11
Contribution.md is quite generic, since I understand this is a mutable document for now until we have more details about our stack.