Skip to content

Commit 4185a63

Browse files
chore: add linter config
Signed-off-by: Matthias Pichler <[email protected]>
1 parent ffcf80b commit 4185a63

17 files changed

+992
-883
lines changed

Diff for: .gherkin-lintrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

Diff for: .markdownlint.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
14-
14+
---
1515
{
1616
"default": true,
17-
"MD024": { "allow_different_nesting": true },
17+
"MD024": { "siblings_only": true },
1818
"MD029": { "style": "ordered" },
19-
"ul-style": false, # MD004
20-
"line-length": false, # MD013
21-
"no-inline-html": false, # MD033
22-
"fenced-code-language": false # MD040
19+
"ul-style": false, # MD004
20+
"line-length": false, # MD013
21+
"no-inline-html": false, # MD033
22+
"fenced-code-language": false, # MD040
2323
}

Diff for: .vscode/extensions.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"recommendations": ["davidanson.vscode-markdownlint", "redhat.vscode-yaml"]
3+
}

Diff for: .vscode/settings.json

+18-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
11
{
22
"rewrap.wrappingColumn": 80,
33
"editor.rulers": [80],
4-
"markdownlint.config": {
5-
"MD004": false,
6-
"MD013": false,
7-
"MD024": {"allow_different_nesting": true},
8-
"MD029": {"style": "ordered"},
9-
"MD033": false,
10-
"MD040": false,
4+
"yaml.format.singleQuote": false,
5+
"yaml.format.proseWrap": "always",
6+
"yaml.format.bracketSpacing": true,
7+
"yaml.format.enable": true,
8+
"[yaml]": {
9+
"editor.defaultFormatter": "redhat.vscode-yaml"
10+
},
11+
"[markdown]": {
12+
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
1113
},
12-
}
14+
"markdownlint.config": {
15+
"MD004": false,
16+
"MD013": false,
17+
"MD024": { "siblings_only": true },
18+
"MD029": { "style": "ordered" },
19+
"MD033": false,
20+
"MD040": false
21+
}
22+
}

Diff for: .yamllint.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
extends: default
3+
4+
rules:
5+
comments:
6+
min-spaces-from-content: 1
7+
braces:
8+
min-spaces-inside: 1
9+
max-spaces-inside: 1

Diff for: GOVERNANCE.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ As a CNCF member project, we abide by the [CNCF Code of Conduct](https://github.
55
For specific guidance on practical contribution steps for any Serverless Workflow sub-project please
66
see our [contributing guide](contributing.md).
77

8-
You can contact the project maintainers at any time by sending an email to the
8+
You can contact the project maintainers at any time by sending an email to the
99
[Serverless Workflow Specification Maintainers](mailto:[email protected])
10-
mailing list.
10+
mailing list.
1111

1212
## Maintainership
1313

1414
Main responsibilities of maintainers include:
1515

16-
1) Sharing responsibility for the project's success.
17-
2) Making a long-term, recurring time investment to improve the project.
18-
3) Performing necessary tasks, even if they are not the most interesting or fun.
16+
1. Sharing responsibility for the project's success.
17+
2. Making a long-term, recurring time investment to improve the project.
18+
3. Performing necessary tasks, even if they are not the most interesting or fun.
1919

2020
## Reviewers
2121

@@ -26,9 +26,9 @@ Their pull request approvals are needed to merge code changes into the project.
2626

2727
Emeritus maintainers are retired maintainers who have provided valuable contributions to the project in the past but are not able to dedicate the time necessary to be fully active maintainers going forward. While their efforts will be focused elsewhere, it is hoped that they will try to find the time to continue to be active participants in the community by:
2828

29-
1) Providing guidance and mentorship to current maintainers and contributors.
30-
2) Offering historical context and insights based on their past experiences.
31-
3) Participating in discussions and reviews on an advisory basis, without the obligations of active maintainers.
29+
1. Providing guidance and mentorship to current maintainers and contributors.
30+
2. Offering historical context and insights based on their past experiences.
31+
3. Participating in discussions and reviews on an advisory basis, without the obligations of active maintainers.
3232

3333
## Adding maintainers
3434

@@ -100,8 +100,8 @@ by a pull request removing them.
100100

101101
Serverless Workflow is an open-source project with an open design philosophy. This means
102102
that the repository is the source of truth for EVERY aspect of the project,
103-
including its philosophy, design, road map, and APIs. *If it's part of the
104-
project, it's in the repository. If it's in the repository, it's part of the project.*
103+
including its philosophy, design, road map, and APIs. _If it's part of the
104+
project, it's in the repository. If it's in the repository, it's part of the project._
105105

106106
As a result, all decisions can be expressed as changes to the repository. An
107107
implementation change is a change to the source code. An API change is a change
@@ -115,12 +115,12 @@ the [discussion](discussions) tool.
115115

116116
All decisions affecting Serverless Workflow, big and small, follow the same 3 steps:
117117

118-
* Step 1: Open a pull request. Anyone can do this.
118+
- Step 1: Open a pull request. Anyone can do this.
119119

120-
* Step 2: Discuss the pull request. Anyone can do this.
120+
- Step 2: Discuss the pull request. Anyone can do this.
121121

122-
* Step 3: Merge or refuse the pull request. Who does this depends on the nature
123-
of the pull request and which areas of the project it affects.
122+
- Step 3: Merge or refuse the pull request. Who does this depends on the nature
123+
of the pull request and which areas of the project it affects.
124124

125125
## I'm a maintainer. Should I make pull requests too?
126126

Diff for: MAINTAINERS.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Serverless Workflow Org Maintainers
22

3-
* [Charles d'Avernas](https://github.com/cdavernas)
4-
* [Ricardo Zanini](https://github.com/ricardozanini)
3+
- [Charles d'Avernas](https://github.com/cdavernas)
4+
- [Ricardo Zanini](https://github.com/ricardozanini)
55

66
# Serverless Workflow Org Emeritus Maintainers
7-
* [Antonio Mendoza Pérez](https://github.com/antmendoza)
8-
* [Tihomir Surdilovic](https://github.com/tsurdilo)
7+
8+
- [Antonio Mendoza Pérez](https://github.com/antmendoza)
9+
- [Tihomir Surdilovic](https://github.com/tsurdilo)
910

1011
# Maintainers Mailing list
12+
1113
[cncf-serverlessws-maintainers](mailto:[email protected])

Diff for: README.md

+29-27
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,35 @@
11
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-green.svg?style=flat)](https://github.com/serverlessworkflow/specification/issues)
22
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/serverlessworkflow/specification/blob/master/LICENSE)
3-
[<img src="http://img.shields.io/badge/slack-@serverless--workflow-red?style=social&logo=slack">](https://cloud-native.slack.com/messages/serverless-workflow)
4-
[<img src="http://img.shields.io/badge/web-serverlessworkflow.io-red?style=social&logo=google-chrome">](https://serverlessworkflow.io/)
3+
[<img src="http://img.shields.io/badge/slack-@serverless--workflow-red?style=social&logo=slack">](https://cloud-native.slack.com/messages/serverless-workflow)
4+
[<img src="http://img.shields.io/badge/web-serverlessworkflow.io-red?style=social&logo=google-chrome">](https://serverlessworkflow.io/)
55
[<img src="https://img.shields.io/twitter/follow/CNCFWorkflow?style=social">](https://twitter.com/CNCFWorkflow)
66

77
## Table of Contents
88

99
- [About](#about)
1010
- [Ecosystem](#ecosystem)
11-
+ [DSL](dsl.md)
12-
+ [CTK](/ctk/readme.md)
13-
+ [SDKs](#sdks)
14-
+ [Runtimes](#runtimes)
15-
+ [Tooling](#Tooling)
16-
+ [Landscape](#cncf-landscape)
11+
- [DSL](dsl.md)
12+
- [CTK](/ctk/readme.md)
13+
- [SDKs](#sdks)
14+
- [Runtimes](#runtimes)
15+
- [Tooling](#Tooling)
16+
- [Landscape](#cncf-landscape)
1717
- [Documentation](#documentation)
1818
- [Community](#community)
19-
+ [Communication](#communication)
20-
+ [Governance](#governance)
21-
+ [Code of Conduct](#code-of-conduct)
22-
+ [Weekly Meetings](#weekly-meetings)
23-
+ [Support](#support)
19+
- [Communication](#communication)
20+
- [Governance](#governance)
21+
- [Code of Conduct](#code-of-conduct)
22+
- [Weekly Meetings](#weekly-meetings)
23+
24+
* [Support](#support)
2425
- [Adoption](#adoption)
2526
- [Sponsoring](#sponsoring)
2627

2728
## About
2829

29-
Serverless Workflow presents a vendor-neutral, open-source, and entirely community-driven ecosystem tailored for defining and executing DSL-based workflows in the realm of Serverless technology.
30+
Serverless Workflow presents a vendor-neutral, open-source, and entirely community-driven ecosystem tailored for defining and executing DSL-based workflows in the realm of Serverless technology.
3031

31-
The Serverless Workflow DSL is a high-level language that reshapes the terrain of workflow creation, boasting a design that is ubiquitous, intuitive, imperative, and fluent.
32+
The Serverless Workflow DSL is a high-level language that reshapes the terrain of workflow creation, boasting a design that is ubiquitous, intuitive, imperative, and fluent.
3233

3334
Bid farewell to convoluted coding and platform dependencies—now, crafting powerful workflows is effortlessly within reach for everyone!
3435

@@ -50,7 +51,7 @@ Key features:
5051
Serverless Workflow ecosystem is hosted by the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/) and was approved as a
5152
Cloud Native Sandbox level project on July 14, 2020.
5253

53-
It encompasses a comprehensive suite of components and tools designed to facilitate the creation, management, and execution of serverless workflows.
54+
It encompasses a comprehensive suite of components and tools designed to facilitate the creation, management, and execution of serverless workflows.
5455

5556
1. **[DSL](dsl.md) (Domain Specific Language)**: The core of the ecosystem, defining the fundamental syntax and semantics of Serverless Workflow specifications.
5657

@@ -82,10 +83,10 @@ No matter your preferred language, our SDKs provide the tools you need to levera
8283

8384
### Runtimes
8485

85-
| Name | About |
86-
| --- | --- |
87-
| [Apache KIE SonataFlow](https://sonataflow.org) | Apache KIE SonataFlow is a tool for building cloud-native workflow applications. You can use it to do the services and events orchestration and choreography. |
88-
| [Synapse](https://github.com/serverlessworkflow/synapse) | Synapse is a scalable, cross-platform, fully customizable platform for managing and running Serverless Workflows. |
86+
| Name | About |
87+
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
88+
| [Apache KIE SonataFlow](https://sonataflow.org) | Apache KIE SonataFlow is a tool for building cloud-native workflow applications. You can use it to do the services and events orchestration and choreography. |
89+
| [Synapse](https://github.com/serverlessworkflow/synapse) | Synapse is a scalable, cross-platform, fully customizable platform for managing and running Serverless Workflows. |
8990

9091
### Tooling
9192

@@ -106,6 +107,7 @@ It is a member project of the [CNCF Serverless Working Group](https://github.com
106107
## Documentation
107108

108109
The documentation for Serverless Workflow includes:
110+
109111
- [**DSL**](dsl.md): Documents the fundamentals aspects and concepts of the Serverless Workflow DSL
110112
- [**DSL Reference**](dsl-reference.md): References all the definitions used by the Serverless Workflow DSL
111113

@@ -120,22 +122,22 @@ To learn how to contribute to the specification please refer to ['how to contrib
120122

121123
If you have any copyright questions when contributing to a CNCF project like this one,
122124
reference the [Ownership of Copyrights in CNCF Project Contributions](https://github.com/cncf/foundation/blob/master/copyright-notices.md).
123-
125+
124126
### Communication
125127

126-
- Community Slack Channel: [https://slack.cncf.io/](https://slack.cncf.io/) - #serverless-workflow
128+
- Community Slack Channel: [https://slack.cncf.io/](https://slack.cncf.io/) - #serverless-workflow
127129
- [Weekly project meetings](#weekly-meetings)
128130
- Project Maintainers Email: [cncf-serverlessws-maintainers](mailto:[email protected])
129131
- Serverless WG Email: [cncf-wg-serverless](mailto:[email protected])
130132
- Serverless WG Subscription: [https://lists.cncf.io/g/cncf-wg-serverless](https://lists.cncf.io/g/cncf-wg-serverless)
131133

132134
### Governance
133135

134-
The Serverless Workflow Project Governance [document](governance.md) delineates the roles, procedures, and principles guiding the collaborative development and maintenance of the project.
136+
The Serverless Workflow Project Governance [document](governance.md) delineates the roles, procedures, and principles guiding the collaborative development and maintenance of the project.
135137

136138
It emphasizes adherence to the CNCF Code of Conduct, defines the responsibilities of maintainers, reviewers, and emeritus maintainers, outlines procedures for their addition and removal, and establishes guidelines for subprojects' inclusion and compliance.
137139

138-
Decision-making processes are consensus-driven, facilitated through structured proposal and discussion mechanisms, with conflict resolution procedures prioritizing amicable resolution.
140+
Decision-making processes are consensus-driven, facilitated through structured proposal and discussion mechanisms, with conflict resolution procedures prioritizing amicable resolution.
139141

140142
Overall, the document reflects the project's commitment to transparency, accountability, and inclusive collaboration, fostering an environment conducive to sustained growth and innovation.
141143

@@ -171,10 +173,10 @@ If you're using Serverless Workflow in your projects and would like to showcase
171173

172174
### Sponsoring
173175

174-
As an open-source project, Serverless Workflow relies on the support of sponsors to sustain its development and growth.
176+
As an open-source project, Serverless Workflow relies on the support of sponsors to sustain its development and growth.
175177

176-
By becoming a sponsor, you'll not only demonstrate your commitment to advancing serverless technologies but also gain visibility within our vibrant community.
178+
By becoming a sponsor, you'll not only demonstrate your commitment to advancing serverless technologies but also gain visibility within our vibrant community.
177179

178180
Sponsorship opportunities range from financial contributions to in-kind support, and every sponsorship makes a meaningful impact on the project's success and sustainability.
179181

180-
Support our project by [becoming a Sponsor](https://crowdfunding.lfx.linuxfoundation.org/projects/serverless-workflow).
182+
Support our project by [becoming a Sponsor](https://crowdfunding.lfx.linuxfoundation.org/projects/serverless-workflow).

Diff for: code-of-conduct.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/mai
77
If your project isn't prepared to handle reports, remove the project email address and just have
88
reporters send to [email protected].
99
-->
10+
1011
Please contact the [CNCF Code of Conduct Committee](mailto:[email protected])
1112
in order to report violations of the Code of Conduct.

Diff for: community/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Community
1+
# Community
22

33
Here you can find information about our:
44

55
- [Contributors](contributors.md): People and companies contributing to the
66
Serverless workflow specification and ecosystem
7-
- [Presentations](https://serverlessworkflow.io/): Community presentations about the project (see the 'Resources' section)
7+
- [Presentations](https://serverlessworkflow.io/): Community presentations about the project (see the 'Resources' section)

0 commit comments

Comments
 (0)