Thank you for considering contributing to Projectsveltos! Before you start, please take a moment to read the guidelines below.
To contribute to Projectsveltos, please follow these steps:
- Fork this repository.
- Create a new branch for your changes.
- Make your changes and commit them with a clear commit message.
- Push your changes to your forked repository.
- Create a pull request to the dev repository.
Always verify your changes locally before pushing a PR:
- make lint
- make test
- make kind-test
Projectsveltos repos have three types of branches: the main branch, the dev branch and release-X branches.
The dev branch is where development happens. All the latest and greatest code, including breaking changes, happens on dev.
The release-X branches contain stable, backwards compatible code. On every major or minor release, a new branch is created. It is from these branches that minor and patch releases are tagged. In some cases, it may be necessary to open PRs for bugfixes directly against stable branches, but this should generally not be the case.
If you encounter any bugs or issues, please report them by creating a new issue in the Issues tab.
If you have any questions or feedback, please feel free to contact us by email at support@projectsveltos.io or on the projectsveltos slack channel.
Happy coding!