From 7cf501eb5ece8d00025bb04af2ffe8786c35c18c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susa=20T=C3=BCnker?= <74345218+sujaya-sys@users.noreply.github.com> Date: Sun, 20 Oct 2024 14:34:50 +0200 Subject: [PATCH 1/3] docs(readme): Add suggestion for contribution guide --- CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8f5293c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Contributor guidelines + +We are excited that you're interested in contributing to this project! Your efforts help us improve and grow. + +# Ways to contribute + +There are many ways for you to contribute to the Checkly operator, for example: + +- **User feedback:** Share your feedback and impressions about the operator. Your insights are incredibly helpful for us to further improve and develop the project. +- **Documentation:** Help us identify and fix gaps or issues in our documentation. +- **Bug reports & fixes:** Encountered a bug or unexpected behavior? Please report it to us, and if possible, contribute a fix. +- **Feature enhancements:** Propose or work on new features for the operator. + +# Finding an issue + +You can discover reported bugs, feature ideas, or discussion topics in the [Issues section](https://github.com/checkly/checkly-operator/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. + +# How to get in touch + +You can reach us anytime on **#checkly-k8s-operator** channel in the [Checkly community Slack](https://www.checklyhq.com/slack). + +# Commit message guidelines +We follow the **Angular Conventional Commits** format to ensure consistent and meaningful commit messages, which streamline our release process. + +Here’s the basic format: + +- `(): ` + + - **Type**: What kind of change you’re making, like: + - `feat`: Adding a new feature. + - `fix`: Fixing a bug. + - `docs`: Updating documentation. + - `style`: Code style changes (e.g., formatting). + - `refactor`: Changing code without affecting how it works. + - `test`: Adding or updating tests. + - `chore`: Routine tasks (e.g., updating dependencies). + + - **Scope**: Where the change happens (e.g., `operator`, `readme`). + + - **Description**: A short summary of the change. + +Some examples: +- `docs(readme): Add commit message guidelines` +- `fix(operator): Fix timeout issue in deployment` + +For more info, check out the [Conventional Commits guide](https://www.conventionalcommits.org/en/v1.0.0/). + +# Contribution workflow + +Our general approach follows the "fork-and-pull" Git workflow: + +1. Fork the repository on GitHub. +2. Clone the project to your local machine. +3. Make your changes and commit them to a new branch. +4. Push your branch to your forked repository. +5. Open a Pull Request so we can review and discuss your changes. + From 405082ab260c9903ecfc4ba2cc2d046c0f4b939d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susa=20T=C3=BCnker?= <74345218+sujaya-sys@users.noreply.github.com> Date: Sun, 20 Oct 2024 14:42:54 +0200 Subject: [PATCH 2/3] docs(readme): Added commit message guidelines --- CONTRIBUTING.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f5293c..51a103b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,22 +26,19 @@ Here’s the basic format: - `(): ` - - **Type**: What kind of change you’re making, like: - - `feat`: Adding a new feature. - - `fix`: Fixing a bug. + - **Type**: What kind of change you’re making. Common examples: + - `feat`: Introducing a new feature to the codebase. + - `fix`: Patching a bug in the codebase. - `docs`: Updating documentation. - - `style`: Code style changes (e.g., formatting). - - `refactor`: Changing code without affecting how it works. - - `test`: Adding or updating tests. - - `chore`: Routine tasks (e.g., updating dependencies). + - ... - **Scope**: Where the change happens (e.g., `operator`, `readme`). - **Description**: A short summary of the change. -Some examples: +Examples: - `docs(readme): Add commit message guidelines` -- `fix(operator): Fix timeout issue in deployment` +- `build(deps): bump golang.org/x/net from 0.13.0 to 0.23.0` For more info, check out the [Conventional Commits guide](https://www.conventionalcommits.org/en/v1.0.0/). From 59e91ed46088102cf429a009ec70454cd234f51b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susa=20T=C3=BCnker?= <74345218+sujaya-sys@users.noreply.github.com> Date: Sun, 20 Oct 2024 14:45:18 +0200 Subject: [PATCH 3/3] docs(readme): Updated example in contribution guide --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51a103b..047c89f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ Here’s the basic format: - `docs`: Updating documentation. - ... - - **Scope**: Where the change happens (e.g., `operator`, `readme`). + - **Scope**: Where the change happens (e.g., `deps`, `readme`). - **Description**: A short summary of the change.