Welcome to Kubernetes. We are excited about the prospect of you joining our community! The Kubernetes community abides by the CNCF code of conduct. Here is an excerpt:
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
We have full documentation on how to get started contributing here:
- Contributor License Agreement Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests
- Kubernetes Contributor Guide - Main contributor documentation, or you can just jump directly to the contributing section
- Contributor Cheat Sheet - Common resources for existing developers
- Mentoring Initiatives - We have a diverse set of mentorship programs available that are always looking for volunteers!
- Clone the repository by running
git clone https://github.com/kubernetes-sigs/depstat.git
- Create another branch where you'll be making your changes by running,
git checkout -b branch_name
-
After making your changes you can test them by creating a binary of depstat with your changes. To do this run,
go build. This will create a binary of depstat with your changes in the project root which you can use to test. -
After you're satisfied with your changes, commit and push your branch:
git add .
git commit -s -m "commit message goes here"
git push origin branch_name
- You can now use this branch to create a pull request to the
mainbranch of the project.
You can read more about the GitHub Workflow here.
- One of the important jobs run in the CI is golangci-lint. You might see it complaining about code formatting and its output can be confusing at times. You can run
gofmt -d .locally to see the changes needed to make the CI happy :)