Skip to content

Commit

Permalink
docs: update default files
Browse files Browse the repository at this point in the history
* Update CONTRIBUTING
* Update README with Contributing and License reference
  • Loading branch information
ialejandro committed Nov 9, 2024
1 parent 6f7e59a commit 523c198
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# How to contribute to KDL
# How to contribute to helm-charts

This document provides guidelines for contributing to the *KDL* project.
This document provides guidelines for contributing to the *helm-charts* project.

## How can I contribute?

### Did you find a bug?

* **Ensure the bug has not already been reported** by searching on GitHub under [Issues](https://github.com/konstellation-io/kdl-server/issues).
* If you cannot find an open issue addressing the problem, [open a new one](https://github.com/konstellation-io/kdl-server/issues/new). Include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the unexpected behavior.
* **Ensure the bug has not already been reported** by searching on GitHub under [Issues](https://github.com/konstellation-io/helm-charts/issues).
* If you cannot find an open issue addressing the problem, [open a new one](https://github.com/konstellation-io/helm-charts/issues/new). Include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the unexpected behavior.
* Use the relevant bug report templates to create the issue, if available.

### Do you intend to add a new feature or change an existing one?

* Please discuss first ([open an issue](https://github.com/konstellation-io/kdl-server/issues)) before starting any significant pull request (e.g., implementing features, refactoring code) to avoid spending time on something that might not be merged.
* Please discuss first ([open an issue](https://github.com/konstellation-io/helm-charts/issues)) before starting any significant pull request (e.g., implementing features, refactoring code) to avoid spending time on something that might not be merged.
* Adhere to the project's coding conventions (indentation, accurate comments, etc.) and any other requirements (such as test coverage, documentation).

## Styleguides
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,11 @@ Charts are also available in OCI format. The list of available charts can be fou
```console
helm install [RELEASE_NAME] oci://ghcr.io/konstellation-io/helm-charts/<helm-chart-name> --version=[version]
```

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit 523c198

Please sign in to comment.