Skip to content

Commit

Permalink
Merge pull request #46 from gianlucam76/main
Browse files Browse the repository at this point in the history
Merge dev to main
  • Loading branch information
gianlucam76 committed Apr 5, 2023
2 parents 97bcc39 + 33f3a9d commit 0085401
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to Projectsveltos

Thank you for considering contributing to Projectsveltos! Before you start, please take a moment to read the guidelines below.

## Contributing

To contribute to Projectsveltos, please follow these steps:

1. Fork this repository.
2. Create a new branch for your changes.
3. Make your changes and commit them with a clear commit message.
4. Push your changes to your forked repository.
5. Create a pull request to the dev repository.

Always verify your changes locally before pushing a PR:

1. make lint
2. make test
3. make kind-test

## Branches

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.

## Reporting Bugs

If you encounter any bugs or issues, please report them by creating a new issue in the [Issues](https://github.com/projectsveltos/sveltoscluster-manager/issues) tab.

## Contact Us

If you have any questions or feedback, please feel free to contact us by email at support@projectsveltos.io or on the [projectsveltos](https://join.slack.com/t/projectsveltos/shared_invite/zt-1hraownbr-W8NTs6LTimxLPB8Erj8Q6Q) slack channel.

Happy coding!

0 comments on commit 0085401

Please sign in to comment.