Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 133 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
**info@stablekernel.com**.

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[mozilla]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
78 changes: 76 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,83 @@ golangci-lint run ./...
5. Run `go test ./...` and `golangci-lint run ./...` before pushing.
6. Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages (`feat:`, `fix:`, `docs:`, `chore:`, ...). cascade derives changelogs and version bumps from them.

## API design
## Test policy

cascade requires tests for changes that add or change behavior. This is a
condition of acceptance, not a suggestion.

- **Major new functionality must ship with tests.** Any change that adds a
feature, a CLI command or flag, a manifest field, or generator behavior must
include automated tests that cover the new behavior. A pull request that adds
functionality without tests will be asked to add them before it can merge.
- **Generator features need an end-to-end scenario.** New manifest fields and
generator features require an `e2e/` scenario that exercises the generated
workflow, not only a unit test asserting on generated output. A generator
change with no `e2e/` scenario does not meet the bar.
- **Bug fixes should include a regression test.** When you fix a bug, add a test
that fails before your fix and passes after it, so the bug cannot return
unnoticed.
- **Tests run in CI on every pull request.** The test suite and the linter run
automatically on each pull request and must pass before merge.

Run the suites locally before pushing:

Public APIs follow a functional-options style: required inputs are positional and optional or extensible behavior arrives as a variadic `...Option` tail, so new capability is additive and never a breaking signature change. Cross-cutting concerns are small interfaces with no-op defaults rather than forced dependencies.
```bash
# Unit tests
go test ./...

# End-to-end tests (requires Docker; uses testcontainers + gitea)
cd e2e && go test -v -timeout 20m ./...
```

The normal inner loop is `go build ./...`, `go test ./...`, and the linter; the
full Docker-backed end-to-end suite is run when your change affects generated
workflow behavior.

## Coding standard

cascade follows standard Go style, enforced automatically. Contributions are
expected to meet it.

- **Formatting.** Code must be `gofmt`-clean. Use `gofmt` (or `goimports`) before
committing.
- **Linting.** cascade uses `golangci-lint` as its coding standard. Your change
must pass it with no new findings:

```bash
golangci-lint run ./...
```

The linter runs in CI and is part of the merge bar. Treat its warnings as
errors: do not merge changes that introduce new lint findings, and do not
silence findings with blanket suppressions. Narrowly scoped, justified
suppressions are acceptable only when a finding is a genuine false positive.
- **Idiomatic Go.** Follow effective, idiomatic Go: clear naming, small focused
functions, errors wrapped with context, no unused exports. The build must be
warning-free.
- **API design.** Public APIs use a functional-options style: required inputs are
positional and optional or extensible behavior arrives as a variadic
`...Option` tail, so new capability is additive and never a breaking signature
change. Cross-cutting concerns are small interfaces with no-op defaults rather
than forced dependencies.

## Contribution requirements summary

To be accepted, a contribution must:

1. Be a single logical change in its own pull request, branched from `main`.
2. Sign off every commit under the
[Developer Certificate of Origin](https://developercertificate.org/)
(`git commit -s`).
3. Use [Conventional Commits](https://www.conventionalcommits.org/) for commit
messages.
4. Include tests for new or changed behavior, with an `e2e/` scenario for
generator and manifest changes.
5. Pass `go test ./...` and `golangci-lint run ./...`.
6. Keep the manifest schema additive: new fields are optional with sensible
defaults; existing fields are not removed or renamed within a major version.

By participating you agree to the [Code of Conduct](./CODE_OF_CONDUCT.md).

## Reporting bugs

Expand Down
Loading
Loading