How to Contribute to Hyvä

You can contribute to various Hyvä projects. This guide focuses on **Hyvä Core contributions** (Hyvä Themes, Checkout, Enterprise, UI). For other projects, see the specific guidelines:

• **Commercial Hyvä License Required** (access on gitlab.hyva.io):
  • Compatibility Modules (contribution guideline)
  • Hyvä Themes
  • Hyvä Checkout
  • Hyvä Enterprise
  • Hyvä UI
• **Open-Source Projects** (free on GitHub, follow standard GitHub contribution processes):
  • React Checkout
  • Hyvä Admin

Throughout this document, **GitLab** refers to gitlab.hyva.io.

Hyvä Core Contribution Process: Step-by-Step

1. Request GitLab fork permissions from a Hyvä team member in Slack.
2. Fork the target repository into your GitLab group.
3. Clone your forked repository to your local development environment.
4. **Create or Link an Issue:** Before coding, ensure an issue exists in the original GitLab repository for your contribution. If not, create one with a descriptive title and reproduction steps (if applicable). Linking your merge request to an issue streamlines code review, helps others identify problems, and aids in changelog generation and attribution.
5. Create a feature branch in your local environment.
6. Implement your changes.
7. Commit your changes regularly.
8. Push your branch to GitLab and create a merge request, linking it to the relevant issue in the description.

Updating Outdated Forks

To update your fork with the latest changes from the Hyvä repository:

1. Run the following command to fetch the latest changes from the Hyvä repository:
   git fetch upstream
   

2. Create a new branch based on the latest upstream changes:
   git checkout -b <branch-name> upstream/<branch-name>
   

   Replace with your desired branch name.

3. Push the new branch to your fork on GitLab:
   git push origin <branch-name>
   

   Replace with the same branch name used in the previous step.