CONTRIBUTING.md

# Contributing guidelines

Thanks for finding a moment for your contribution! We really appreciate it!
The below rules are here to speed things up and streamline work on both sides - us as library maintainers and you as the contributor.

## Reporting a bug

First check if it's not already reported. Use the "bug" tag for filtering.
If it's not, create a new one using the template. If it already exists, give it a thumb-up and optionally share any helpful details in the comments.

## Requesting a feature

There's also a designated template for it, and the rule of checking if the request is already tracked also applies.

## Requesting/adding support for an action

Apart from filing an issue using the template, we strongly encourage you to:
* ask the owner to provide the typings using https://github.com/krzema12/github-actions-typing - it greatly limits the amount of work needed in this DSL library, both when adding and maintaining support for actions. For inspiration how such request could look, see https://github.com/madhead/read-java-properties/issues/36
* create a PR that adds support for the action. Start by modifying https://github.com/krzema12/github-actions-kotlin-dsl/blob/main/wrapper-generator/src/main/kotlin/it/krzeminski/githubactions/wrappergenerator/WrappersToGenerate.kt and then running `./gradlew :wrapper-generator:run` to (re)generate various files

## Contributing a feature

Each feature contribution must have an accompanying feature request issue, best if we discuss the approach in the issue first to avoid misunderstandings and wasted time. If the feature is simple, go ahead with creating the issue and the PR in parallel.