Skip to content

Commit

Permalink
docs(readme): Add suggestion for contribution guide (#40)
Browse files Browse the repository at this point in the history
* docs(readme): Add suggestion for contribution guide

* docs(readme): Added commit message guidelines

* docs(readme): Updated example in contribution guide
  • Loading branch information
sujaya-sys authored Oct 21, 2024
1 parent ef0e00e commit 78aa081
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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>(<scope>): <description>`

- **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.
- ...

- **Scope**: Where the change happens (e.g., `deps`, `readme`).

- **Description**: A short summary of the change.

Examples:
- `docs(readme): Add commit message guidelines`
- `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/).

# 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.

0 comments on commit 78aa081

Please sign in to comment.