You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+44-11Lines changed: 44 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
<!--
2
2
Copyright 2021-Present The Serverless Workflow Specification Authors
3
-
3
+
4
4
Licensed under the Apache License, Version 2.0 (the "License");
5
5
you may not use this file except in compliance with the License.
6
6
You may obtain a copy of the License at
7
-
7
+
8
8
http://www.apache.org/licenses/LICENSE-2.0
9
-
9
+
10
10
Unless required by applicable law or agreed to in writing, software
11
11
distributed under the License is distributed on an "AS IS" BASIS,
12
12
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -25,6 +25,7 @@ This project is the official, vendor-neutral visual editor for the [Serverless W
25
25
## Prerequisites
26
26
27
27
To build and run the editor locally, you will need:
28
+
28
29
-**Node.js** (current LTS version; see https://nodejs.org/)
29
30
-**pnpm**
30
31
@@ -51,32 +52,63 @@ pnpm run build:prod
51
52
52
53
This project uses the following core technology stack:
53
54
54
-
***Language**: [TypeScript](https://www.typescriptlang.org/) (for type safety and maintainability)
55
-
***Library**: [React](https://react.dev/) (for building the user interface)
55
+
-**Language**: [TypeScript](https://www.typescriptlang.org/) (for type safety and maintainability)
56
+
-**Library**: [React](https://react.dev/) (for building the user interface)
56
57
57
58
The project aims for the editor to be **embeddable**, with the core logic decoupled from specific platform APIs (like VS Code or Chrome APIs) through an abstraction layer.
58
59
59
60
## Reporting an Issue
60
61
61
62
If you find a bug or have a question, please check the [existing issues](https://github.com/serverlessworkflow/editor/issues) first.
63
+
62
64
1. Open a new issue using the appropriate template.
63
65
2. Provide a clear description of the problem.
64
66
3. Include steps to reproduce the bug and provide a sample workflow file (`.sw.json` or `.sw.yaml`) if applicable.
65
67
66
68
## Suggesting a Change
67
69
68
70
For new features or architectural changes:
71
+
69
72
1. Open an **Issue** or a **GitHub Discussion** to propose your idea.
70
73
2. Ensure the proposal aligns with the goals of being **vendor-neutral** and **specification-first**.
71
74
3. Once the approach is agreed upon by maintainers, you may proceed with a Pull Request.
72
75
73
76
## Coding Standards
74
77
75
-
***TypeScript**: Always use strict typing. Avoid `any`.
76
-
***Linting & Formatting**: Follow the existing code style and formatting conventions used in the files you are editing. If the package you are changing defines linting or formatting scripts, run those before submitting code.
77
-
***Testing**: Ensure that logic changes are covered by tests, and run the relevant test commands for the packages you modify (see their documentation or `package.json`).
78
-
***Component Design**: Follow functional component patterns and ensure that UI state is managed predictably within the monorepo structure.
79
-
***New package creation**: If a new package needs to be created, please follow the standards used by the existing packages, including the standard commands `build:dev`, `build:prod`, `test`, `e2e-test`, `lint`
78
+
-**TypeScript**: Always use strict typing. Avoid `any`.
79
+
-**Linting & Formatting**: Follow the existing code style and formatting conventions used in the files you are editing. If the package you are changing defines linting or formatting scripts, run those before submitting code.
80
+
-**Testing**: Ensure that logic changes are covered by tests, and run the relevant test commands for the packages you modify (see their documentation or `package.json`).
81
+
-**Component Design**: Follow functional component patterns and ensure that UI state is managed predictably within the monorepo structure.
82
+
-**New package creation**: If a new package needs to be created, please follow the standards used by the existing packages, including the standard commands `build:dev`, `build:prod`, `test`, `e2e-test`, `lint`.
83
+
84
+
## LLM Usage Policy
85
+
86
+
In this project, we welcome tools that help developers become more productive — including Large Language Models (LLMs) and agents like ChatGPT, GitHub Copilot, and others. To ensure a healthy and productive community, the following expectations apply:
87
+
88
+
- Use LLMs to **assist your development** — drafting code, writing docs, proposing fixes — as long as you **understand, validate, and take responsibility** for the results.
89
+
- Only submit contributions that reflect your **own understanding and intent**.
90
+
- You may use LLMs to help you **write better**, but not to **post more**.
91
+
92
+
### Requirements
93
+
94
+
- Verify behavior, correctness, and compatibility yourself before submitting. Do not ask maintainers to do this for you.
95
+
- Keep changes narrow and focused. Posting large volumes of low-effort suggestions, vague issues, or links with no context — even if technically accurate — is considered spam.
96
+
- Do **NOT** submit code, tests, comments, or issues that are copied directly from an LLM with little or no human oversight. Be prepared to explain all the changes yourself.
97
+
- Do **NOT** submit AI-generated tests that do not validate actual behavior or meaningfully cover functionality.
98
+
- Do **NOT** use bots, agents, or automated tools to open PRs, file issues, or post content without human authorship and responsibility.
99
+
- Do **NOT** include private code, credentials, tokens, or confidential material.
100
+
- Respect licensing and attribution requirements.
101
+
102
+
### Consequences
103
+
104
+
1. We may close issues, PRs, or discussions that violate this policy without detailed explanation.
105
+
2. Repeated violations may result in temporary or permanent restrictions from participating in the project.
106
+
107
+
### If in Doubt
108
+
109
+
If you're unsure whether your use of agents/LLMs is acceptable — ask! We're happy to help contributors learn how to use AI tools effectively **without creating noise**.
110
+
111
+
> This isn't about banning AI — it's about keeping this project collaborative, human-driven, and focused on quality.
80
112
81
113
## Pull Request Process
82
114
@@ -90,4 +122,5 @@ For new features or architectural changes:
90
122
---
91
123
92
124
### Community and Communication
93
-
Join the conversation on the [CNCF Slack](https://slack.cncf.io/) in the `#serverless-workflow` channel.
125
+
126
+
Join the conversation on the [CNCF Slack](https://slack.cncf.io/) in the `#serverless-workflow` channel.
0 commit comments