Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 2.13 KB
Raw

Contributing to Eirini

Thank you for taking the time to contribute to Eirini. You can find more information about the project at:

  1. #eirini-dev slack channel.
  2. PivotalTracker show our current backlog and what we have planned for the near future.
  3. CI pipeline
  4. Project page

How to contribute

Submitting a bug report

We use PivotalTracker to track bugs and a story is automatically created when you submit an issue on GitHub.

Submitting a pull request

Pull requests are the best way to propose changes to the codebase. When a Pull request is submitted, a story is automatically created in the Icebox in our PivotalTracker.

  1. Sign and submit the appropriate individual or corporate CLA
  2. Fork this project into your GitHub organisation or username
  3. Clone your fork on your local machine
  4. Make sure you are up-to-date with the upstream master branch
  5. Create your feature branch
  6. Commit your changes on your feature branch
  7. Run tests and static checks
  8. Deploy your patched version of Eirini in your cluster if needed
  9. Push your feature branch to your fork
  10. Issue a Pull request

Tests & static checks

Before you submit a Pull request, you must make sure that your contribution meets the following requirements:

  • Your change has been well covered by unit tests (if applicable)
  • All tests are passing
  • All static code checks are passing. We enforce that by using golangci-lint

You can check all that by executing the following script:

$ ./scripts/check-everything.sh

Our test scripts depend on telepresence, kind, and skaffold.