-
Notifications
You must be signed in to change notification settings - Fork 612
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of github.com:k8sgpt-ai/k8sgpt
- Loading branch information
Showing
22 changed files
with
375 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {".":"0.0.3"} | ||
| {".":"0.0.4"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,113 @@ | ||
| # Contributing | ||
| We're happy that you want to contribute to this project. Please read the sections to make the process as smooth as possible. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Golang `1.20` | ||
| - An OpenAI API key | ||
| * OpenAI API keys can be obtained from [OpenAI](https://platform.openai.com/account/api-keys) | ||
| * You can set the API key for k8sgpt using `./k8sgpt auth key` | ||
| - If you want to build the container image, you need to have a container engine (docker, podman, rancher, etc.) installed | ||
|
|
||
| ## Getting Started | ||
|
|
||
| **Where should I start?** | ||
| - If you are new to the project, please check out the [good first issue](https://github.com/k8sgpt-ai/k8sgpt/labels/good%20first%20issue) label. | ||
| - If you are looking for something to work on, check out our [open issues](https://github.com/k8sgpt-ai/k8sgpt/issues). | ||
| - If you have an idea for a new feature, please open an issue, and we can discuss it. | ||
| - We are also happy to help you find something to work on. Just reach out to us. | ||
|
|
||
| **Getting in touch with the community** | ||
| * Join our [#k8sgpt slack channel](https://slack.cloud-native.io/channels/k8sgpt) | ||
| * Introduce yourself on the slack channel or open an issue to let us know that you are interested in contributing | ||
|
|
||
| **Discuss issues** | ||
| * Before you start working on something, propose and discuss your solution on the issue | ||
| * If you are unsure about something, ask the community | ||
|
|
||
| **How do I contribute?** | ||
| - Fork the repository and clone it locally | ||
| - Create a new branch and follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines for work undertaken | ||
| - Assign yourself to the issue, if you are working on it (if you are not a member of the organization, please leave a comment on the issue) | ||
| - Make your changes | ||
| - Keep pull requests small and focused, if you have multiple changes, please open multiple PRs | ||
| - Create a pull request back to the upstream repository and follow follow the [pull request template](.github/pull_request_template.md) guidelines. | ||
| - Wait for a review and address any comments | ||
|
|
||
| **Opening PRs** | ||
| - As long as you are working on your PR, please mark it as a draft | ||
| - Please make sure that your PR is up-to-date with the latest changes in `main` | ||
| - Fill out the PR template | ||
| - Mention the issue that your PR is addressing (closes: #<id>) | ||
| - Make sure that your PR passes all checks | ||
|
|
||
| **Reviewing PRs** | ||
| - Be respectful and constructive | ||
| - Assign yourself to the PR | ||
| - Check if all checks are passing | ||
| - Suggest changes instead of simply commenting on found issues | ||
| - If you are unsure about something, ask the author | ||
| - If you are not sure if the changes work, try them out | ||
| - Reach out to other reviewers if you are unsure about something | ||
| - If you are happy with the changes, approve the PR | ||
| - Merge the PR once it has all approvals and the checks are passing | ||
|
|
||
| ## DCO | ||
| We have a DCO check which runs on every PR to verify that the commit has been signed off. | ||
|
|
||
| To sign off the last commit you made, you can use | ||
|
|
||
| ``` | ||
| git commit --amend --signoff | ||
| ``` | ||
|
|
||
| You can also automate signing off your commits by adding the following to your `.zshrc` or `.bashrc`: | ||
|
|
||
| ``` | ||
| git() { | ||
| if [ $# -gt 0 ] && [[ "$1" == "commit" ]] ; then | ||
| shift | ||
| command git commit --signoff "$@" | ||
| else | ||
| command git "$@" | ||
| fi | ||
| } | ||
| ``` | ||
|
|
||
| ## Semantic commits | ||
| We use [Semantic Commits](https://www.conventionalcommits.org/en/v1.0.0/) to make it easier to understand what a commit does and to build pretty changelogs. Please use the following prefixes for your commits: | ||
| - `feat`: A new feature | ||
| - `fix`: A bug fix | ||
| - `docs`: Documentation changes | ||
| - `chores`: Changes to the build process or auxiliary tools and libraries such as documentation generation | ||
| - `refactor`: A code change that neither fixes a bug nor adds a feature | ||
| - `test`: Adding missing tests or correcting existing tests | ||
| - `ci`: Changes to our CI configuration files and scripts | ||
|
|
||
| An example for this could be: | ||
| ``` | ||
| git commit -m "docs: add a new section to the README" | ||
| ``` | ||
|
|
||
| ## Building | ||
| Building the binary is as simple as running `go build .` in the root of the repository. If you want to build the container image, you can run `docker build -t k8sgpt -f container/Dockerfile .` in the root of the repository. | ||
|
|
||
| ## Releasing | ||
| Releases of k8sgpt are done using [Release Please](https://github.com/googleapis/release-please) and [GoReleaser](https://goreleaser.com/). The workflow looks like this: | ||
|
|
||
| * A PR is merged to the `main` branch: | ||
| * Release please is triggered, creates or updates a new release PR | ||
| * This is done with every merge to main, the current release PR is updated every time | ||
|
|
||
| * Merging the 'release please' PR to `main`: | ||
| * Release please is triggered, creates a new release and updates the changelog based on the commit messages | ||
| * GoReleaser is triggered, builds the binaries and attaches them to the release | ||
| * Containers are created and pushed to the container registry | ||
|
|
||
| > With the next relevant merge, a new release PR will be created and the process starts again | ||
| ### Manually setting the version | ||
| If you want to manually set the version, you can create a PR with an empty commit message that contains the version number in the commit message. For example: | ||
|
|
||
| Such a commit can get produced as follows: `git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: 0.0.3` | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.