Skip to content

Commit d4d716e

Browse files
authored
Added contribution guide (#5)
* Added contribution guide * Update CONTRIBUTING.md
1 parent 18766d5 commit d4d716e

File tree

3 files changed

+45
-7
lines changed

3 files changed

+45
-7
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributor guidelines
2+
3+
We are excited that you're interested in contributing to this project!
4+
5+
## Code of conduct
6+
7+
This project adheres to a [Code of Conduct](https://github.com/checkly/helm-charts?tab=coc-ov-file). By participating, you are expected to uphold this code. Please report unacceptable behavior to support@checklyhq.com.
8+
9+
## Ways to contribute
10+
11+
You can contribute by:
12+
13+
- Reporting bugs
14+
- Suggesting or adding features
15+
- Improving our documentation
16+
17+
## Finding an issue
18+
19+
You can discover reported bugs, feature ideas, or discussion topics in the [Issue section](https://github.com/checkly/helm-charts/issues) of this repository. We strive to tag issues with labels such as "good first issue" and "help wanted" to indicate which tasks are up for grabs.
20+
21+
## How to get in touch
22+
23+
You can reach us anytime at support@checklyhq.com or join our [Community Slack](https://join.slack.com/t/checklycommunity/shared_invite/zt-2qc51mpyr-5idwVD4R4izkf5FC4CFk1A).
24+
25+
## Legal
26+
27+
By contributing, you confirm that you have the rights to your work and agree to license it under the [APACHE LICENSE, VERSION 2.0](LICENSE).
28+
29+
## Example contribution workflow
30+
31+
1. Fork this repo
32+
2. Create a new branch for your changes
33+
3. Make your edits or improvements
34+
4. Commit your changes with a short message
35+
5. Open a pull request and describe what you did
36+
6. We’ll review and help if needed!

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright 2025 ChecklyHQ
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Checkly Helm Charts
2-
31
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
42

3+
# Checkly Helm Charts
4+
55
## Usage
66

77
[Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs) to get started.
@@ -12,10 +12,12 @@ Once Helm has been set up correctly, add the repo as follows:
1212

1313
If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages. You can then run `helm search repo checkly` to see all available charts.
1414

15-
## Contributing
15+
## Documentation
16+
More information can be found in our developer docs: [Running Checkly on Kubernetes](https://www.checklyhq.com/docs/private-locations/running-on-kubernetes/#helm-chart).
1617

17-
tbd
18+
## Contributing
19+
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
20+
Our project follows the [Contributor Covenant](https://github.com/checkly/helm-charts?tab=coc-ov-file).
1821

1922
## License
20-
21-
[Apache 2.0 License](https://github.com/checkly/helm-charts/blob/main/LICENSE).
23+
This project is licensed under the [Apache 2.0 License](https://github.com/checkly/helm-charts/blob/main/LICENSE).

0 commit comments

Comments
 (0)