Skip to content

Commit

Permalink
chore: add linter config
Browse files Browse the repository at this point in the history
  • Loading branch information
matthias-pichler committed Jun 27, 2024
1 parent ffcf80b commit 2440b4e
Show file tree
Hide file tree
Showing 17 changed files with 992 additions and 883 deletions.
1 change: 1 addition & 0 deletions .gherkin-lintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
12 changes: 6 additions & 6 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

---
{
"default": true,
"MD024": { "allow_different_nesting": true },
"MD024": { "siblings_only": true },
"MD029": { "style": "ordered" },
"ul-style": false, # MD004
"line-length": false, # MD013
"no-inline-html": false, # MD033
"fenced-code-language": false # MD040
"ul-style": false, # MD004
"line-length": false, # MD013
"no-inline-html": false, # MD033
"fenced-code-language": false, # MD040
}
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["davidanson.vscode-markdownlint", "redhat.vscode-yaml"]
}
26 changes: 18 additions & 8 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
{
"rewrap.wrappingColumn": 80,
"editor.rulers": [80],
"markdownlint.config": {
"MD004": false,
"MD013": false,
"MD024": {"allow_different_nesting": true},
"MD029": {"style": "ordered"},
"MD033": false,
"MD040": false,
"yaml.format.singleQuote": false,
"yaml.format.proseWrap": "always",
"yaml.format.bracketSpacing": true,
"yaml.format.enable": true,
"[yaml]": {
"editor.defaultFormatter": "redhat.vscode-yaml"
},
"[markdown]": {
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
},
}
"markdownlint.config": {
"MD004": false,
"MD013": false,
"MD024": { "siblings_only": true },
"MD029": { "style": "ordered" },
"MD033": false,
"MD040": false
}
}
9 changes: 9 additions & 0 deletions .yamllint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
extends: default

rules:
comments:
min-spaces-from-content: 1
braces:
min-spaces-inside: 1
max-spaces-inside: 1
28 changes: 14 additions & 14 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ As a CNCF member project, we abide by the [CNCF Code of Conduct](https://github.
For specific guidance on practical contribution steps for any Serverless Workflow sub-project please
see our [contributing guide](contributing.md).

You can contact the project maintainers at any time by sending an email to the
You can contact the project maintainers at any time by sending an email to the
[Serverless Workflow Specification Maintainers](mailto:cncf-serverlessws-maintainers@lists.cncf.io)
mailing list.
mailing list.

## Maintainership

Main responsibilities of maintainers include:

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

## Reviewers

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

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:

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

## Adding maintainers

Expand Down Expand Up @@ -100,8 +100,8 @@ by a pull request removing them.

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

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

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

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

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

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

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

Expand Down
10 changes: 6 additions & 4 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Serverless Workflow Org Maintainers

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

# Serverless Workflow Org Emeritus Maintainers
* [Antonio Mendoza Pérez](https://github.com/antmendoza)
* [Tihomir Surdilovic](https://github.com/tsurdilo)

- [Antonio Mendoza Pérez](https://github.com/antmendoza)
- [Tihomir Surdilovic](https://github.com/tsurdilo)

# Maintainers Mailing list

[cncf-serverlessws-maintainers](mailto:cncf-serverlessws-maintainers@lists.cncf.io)
56 changes: 29 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-green.svg?style=flat)](https://github.com/serverlessworkflow/specification/issues)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/serverlessworkflow/specification/blob/master/LICENSE)
[<img src="http://img.shields.io/badge/slack-@serverless--workflow-red?style=social&logo=slack">](https://cloud-native.slack.com/messages/serverless-workflow)
[<img src="http://img.shields.io/badge/web-serverlessworkflow.io-red?style=social&logo=google-chrome">](https://serverlessworkflow.io/)
[<img src="http://img.shields.io/badge/slack-@serverless--workflow-red?style=social&logo=slack">](https://cloud-native.slack.com/messages/serverless-workflow)
[<img src="http://img.shields.io/badge/web-serverlessworkflow.io-red?style=social&logo=google-chrome">](https://serverlessworkflow.io/)
[<img src="https://img.shields.io/twitter/follow/CNCFWorkflow?style=social">](https://twitter.com/CNCFWorkflow)

## Table of Contents

- [About](#about)
- [Ecosystem](#ecosystem)
+ [DSL](dsl.md)
+ [CTK](/ctk/readme.md)
+ [SDKs](#sdks)
+ [Runtimes](#runtimes)
+ [Tooling](#Tooling)
+ [Landscape](#cncf-landscape)
- [DSL](dsl.md)
- [CTK](/ctk/readme.md)
- [SDKs](#sdks)
- [Runtimes](#runtimes)
- [Tooling](#Tooling)
- [Landscape](#cncf-landscape)
- [Documentation](#documentation)
- [Community](#community)
+ [Communication](#communication)
+ [Governance](#governance)
+ [Code of Conduct](#code-of-conduct)
+ [Weekly Meetings](#weekly-meetings)
+ [Support](#support)
- [Communication](#communication)
- [Governance](#governance)
- [Code of Conduct](#code-of-conduct)
- [Weekly Meetings](#weekly-meetings)

* [Support](#support)
- [Adoption](#adoption)
- [Sponsoring](#sponsoring)

## About

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.
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.

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.
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.

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

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

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

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

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

### Runtimes

| Name | About |
| --- | --- |
| [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. |
| [Synapse](https://github.com/serverlessworkflow/synapse) | Synapse is a scalable, cross-platform, fully customizable platform for managing and running Serverless Workflows. |
| Name | About |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [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. |
| [Synapse](https://github.com/serverlessworkflow/synapse) | Synapse is a scalable, cross-platform, fully customizable platform for managing and running Serverless Workflows. |

### Tooling

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

The documentation for Serverless Workflow includes:

- [**DSL**](dsl.md): Documents the fundamentals aspects and concepts of the Serverless Workflow DSL
- [**DSL Reference**](dsl-reference.md): References all the definitions used by the Serverless Workflow DSL

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

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

### Communication

- Community Slack Channel: [https://slack.cncf.io/](https://slack.cncf.io/) - #serverless-workflow
- Community Slack Channel: [https://slack.cncf.io/](https://slack.cncf.io/) - #serverless-workflow
- [Weekly project meetings](#weekly-meetings)
- Project Maintainers Email: [cncf-serverlessws-maintainers](mailto:cncf-serverlessws-maintainers@lists.cncf.io)
- Serverless WG Email: [cncf-wg-serverless](mailto:cncf-wg-serverless@lists.cncf.io)
- Serverless WG Subscription: [https://lists.cncf.io/g/cncf-wg-serverless](https://lists.cncf.io/g/cncf-wg-serverless)

### Governance

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

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.

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

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

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

### Sponsoring

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

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

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

Support our project by [becoming a Sponsor](https://crowdfunding.lfx.linuxfoundation.org/projects/serverless-workflow).
Support our project by [becoming a Sponsor](https://crowdfunding.lfx.linuxfoundation.org/projects/serverless-workflow).
1 change: 1 addition & 0 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/mai
If your project isn't prepared to handle reports, remove the project email address and just have
reporters send to conduct@cncf.io.
-->

Please contact the [CNCF Code of Conduct Committee](mailto:conduct@cncf.io)
in order to report violations of the Code of Conduct.
4 changes: 2 additions & 2 deletions community/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Community
# Community

Here you can find information about our:

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

0 comments on commit 2440b4e

Please sign in to comment.