Welcome! We are glad that you want to contribute to our project!
As you get started, you are in the best position to give us feedback on areas of the project that we need help with, including:
- Problems found during setting up a new developer environment
- Gaps in our documentation
- Bugs in our automation scripts
If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know!
We welcome many different types of contributions including:
- New features
- Builds, CI/CD
- Bug fixes
- Documentation
- Issue Triage
- Answering questions on Slack/Mailing List
- Communications / Social Media / Blog Posts
- Release management
Not everything happens through a GitHub pull request. Please come to our meetings or contact us and let's discuss how we can work together.
Please consider joining the Konveyor community meetings.
Everyone is welcome to come to any of our meetings. You never need an invite to join us. In fact, we want you to join us, even if you don't have anything you feel like you want to contribute. Just being there is enough!
You can find out more about our meetings here. You don't have to turn on your video. The first time you come, introducing yourself is more than enough. Over time, we hope that you feel comfortable voicing your opinions, giving feedback on others' ideas, and even sharing your own ideas and experiences.
You can reach us at kubernetes.slack.com in:
If you don't already have a Slack account for kubernetes.slack.com you can receive an automatic invite via: https://communityinviter.com/apps/kubernetes/community
Subscribe to the [Konveyor emailing lists](https://groups.google.com/g/konveyor-dev https://github.com/konveyor/community?tab=readme-ov-file#mailing-lists)
For technical discussions please join/email:
- konveyor-dev@googlegroups.com
- Konveyor development-related issues and general questions
- Subscribe via: https://groups.google.com/g/konveyor-dev
We have good first issues for new contributors and help wanted issues suitable for any contributor.
- The good first issue tag has extra information to help you make your first contribution.
- The help wanted tag has issues that are suitable for someone who isn't a core maintainer and is good to pursue after your first pull request.
Sometimes there won't be any issues with these labels. That's ok! There is likely still something for you to work on. If you want to contribute but don't know where to start or can't find a suitable issue, you can reach out to us in slack
Once you see an issue that you'd like to work on, please post a comment saying that you want to work on it. Something like "I want to work on this" is fine.
The best way to reach us with a question when contributing is to ask on:
- The original GitHub issue
- The developer mailing list
- Our Slack channel - #konveyor-dev
- Please submit pull requests for the 'main' branch
- Please link your PR to an existing issue, if an existing issue is not present consider creating a new issue
- If the PR is not yet ready you may mark it as a draft, and then once it's ready for review remove the draft status and add a comment to let us know you are ready for a review.
Please ensure the title of your PR begins with a gitmoji. A few examples (with our custom changes) are:
| Bug | :bug: |
Bug fixes |
| Book | :book: |
Documentation |
| Sparkles | :sparkles: |
New features |
| Seedling | :seedling: |
Infrastructure related changes |
| Warning | :warning: |
Breaking changes |
| Ghost | :ghost: |
Misc updates/fixes |
For a full list, please check out gitmoji.dev
Additionally, please make sure your PR title is in the past tense. This is because we generate our release notes from PR titles.
For more info, you can consult the pr check we run at konveyor/release-tools
This repository contains two active components:
kai_mcp_solution_server/- Python MCP solution server. See its README for development setup.kai_analyzer_rpc/- Go analyzer RPC plugin. Build withcd kai_analyzer_rpc && go build -o kai-analyzer main.go.
For IDE extension development, see the editor-extensions repository.
We use Trunk to lint our project.
- Install trunk via: https://docs.trunk.io/check#install-the-cli
- Run the linters:
trunk check - Format code:
trunk fmt
You can also configure Trunk to automatically check your code before pushing via git hooks.
- MCP Solution Server:
cd kai_mcp_solution_server && make test - Go Analyzer:
cd kai_analyzer_rpc && go test ./...
IDE extension tests live in the editor-extensions repository.
Please include tests for new features.
Licensing is important to open source projects. It provides some assurances that the software will continue to be available based on the terms that the author(s) desired. We require that contributors sign off on commits submitted to our project's repositories. The Developer Certificate of Origin (DCO) is a way to certify that you wrote and have the right to contribute the code you are submitting to the project.
You sign off by adding the following to your commit messages. Your sign-off must match the git user and email associated with the commit.
This is my commit message
Signed-off-by: Your Name <your.name@example.com>Git has a -s command line option to do this automatically:
git commit -s -m 'This is my commit message'If you forgot to do this and have not yet pushed your changes to the remote repository, you can amend your commit with the sign-off by running
git commit --amend -sWhen you submit your pull request, or you push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks, but we also have more criteria than just that before we can accept and merge it. We recommend that you check the following things locally before you submit your code:
- Ensure that trunk is happy
trunk checktrunk fmt
- Ensure that tests pass
- If adding a new feature please add a new unit test
- Commits are signed as per DCO
- PR Title begins with a gitemoji as described in Pull Request Title