Itxaka / kairos

:penguin: The immutable Linux meta-distribution for edge Kubernetes.
https://kairos.io
Apache License 2.0
1 stars 0 forks source link

How do I get started with Kairos? #13

Closed devstein closed 3 months ago

devstein commented 4 months ago

I'd like to contribute but don't know where to start

dosubot[bot] commented 4 months ago

To get started with contributing to Kairos, follow these steps:

  1. File an issue: If you found a bug, want to request an enhancement, or want to implement something (bug fix or feature), file an issue first.
  2. Send a pull request: If you want to contribute code, make sure to file an issue first.
  3. Check good first issues: Look at the good first issues to find specific problems to contribute to.
  4. Read the code of conduct and governance: Familiarize yourself with the governance and the CNCF Code of conduct.

For detailed steps on submitting a pull request, follow these best practices:

  1. File an issue: State the problem you want to solve or the feature you want to implement.
  2. Fork the repository: Create your own copy of the repository on GitHub.
  3. Add the upstream source:
    git remote add upstream git@github.com:kairos-io/kairos.git
  4. Create a feature branch: Use a descriptive name, such as fix/dns.
  5. Push your feature branch to your fork: Signal other contributors by commenting on the issue and submit a pull request.
  6. Rebase: Before sending a pull request, rebase against upstream:
    git fetch upstream
    git rebase upstream/master
  7. Run the tests: Ensure all tests and lint checks are passing before submitting a pull request.
    • Linux:
      ./earthly.sh +lint
      ./earthly.sh +test
    • Windows:
      ./earthly.ps1 +lint
      ./earthly.ps1 +test
  8. Send the pull request: Include a description of the work you did and ensure each pull request addresses one issue.

Make sure all commits are signed-off using the -s flag and follow the labeling conventions for your pull request.

For comprehensive docs, tutorials, and examples, see the Kairos documentation [1][2][3].

To continue talking to Dosu, mention @dosu.