Skip to content

Hyvä Contribution Guideline

There are several areas you can contribute to:

  • Compatibility Modules (commercial Hyvä license required for access on gitlab.hyva.io)
  • Hvvä Themes (commercial Hyvä license required)
  • Hyvä Checkout (open-source license, free on github.com)
  • Hyvä Admin (open-source license, free on github.com)

This text focusses on Hyvä core contributions.

The open-source projects follow the usual contribution process on github and are not covered in this document.

Compatibility module contributions have their own compat module contribution guideline.

Please note, in the following, gitlab refers to gitlab.hyva.io.

Tip

If you feel lost during any of the following steps, please ask for help in Slack. We are happy to help you and value contributions very much!

Step by step overview over the Hyvä core contribution process.

  1. To contribute, you first need to request gitlab fork permissions from a Hyvä team member in the Hyvä Slack.

  2. Fork the repository you want to contribute to into your gitlab group.

  3. Probably you now want to clone the repository to your development environment.

  4. Please check there is an issue regarding the topic you will be working on in the original gitlab repo.
    Take note of the issue number. If there is none, please create an issue with a descriptive title. If relevant, please add information on how the problem can be reproduced.
    This is will help speed up the code review process.
    Creating an issue before making a merge request will help people who also encounter the issue pinpoint the problem, and linking merge requests to the issue helps us to build the changelog and giving attribution for new releases!

  5. In your local development environment, create a feature branch.

  6. Now you get to finally work on the code!

  7. Commit your changes. Then go to step 7 and repeat until done.

  8. Push the changes to a new branch on gitlab and create the merge request. Please link to the issue in the merge request description.