Skip to content

Onboarding Guide

This document contains all the information to help you get started.
Reading this will help you get the most out of working with Hyvä.
It provides you with information about resources and some guidelines on how to communicate more effectively as part of the Hyvä community.

Onboarding Information

After purchasing a commercial Hyvä product license, or registering a domain for a free Hyvä Theme key, you will receive a composer key and packagist.com repository URL.
Keep these private. Don't share them with anybody except the people working on a Hyvä project. Be mindful not to publish a private license key in a publicly accessible repository.
It seems obvious, but experience has taught us it needs to be mentioned.

Please see Support for ways to request technical support.

Slack

We use Slack for community support. For an overview of the channels and what each one is used for, see Support.

The following rules have shown to make this kind of communication more fun and effective.

It makes asynchronous communication in channels with many users a lot easier.

Please avoid checking the "Also send to channel" checkbox when replying in a Thread.

For new topics and questions, it's good to start a new thread, rather than adding them to an existing one.

Post a short bug report first, details in a thread

When reporting a bug, please start with a short message of one or two sentences describing the problem, then add the longer details as a reply in the thread.

We appreciate the information AI generated reports provide, but posting a full report as a channel message makes channels hard to read.
A brief summary in the channel with the details in the thread keeps the channels readable and helps support to follow up.

No unsolicited messages promoting services

Promoting integration services via DM or in public channels is unwanted behaviour, and we ask any member of this Slack not to do this.
If you receive such messages, please inform the Hyvä team immediately.
This allows us to take swift action to stop the infringing account from sending further spam messages.

Use code formatting

Learn to use markdown code blocks and code snippets for longer sections of code in Slack.
We talk about code a lot. By using proper formatting it is much easier to understand what is happening and help.

Please don't @mention Hyvä team members

The Hyvä team reads every message as soon as they can. And reply if they are able to help and have the time.

If you don't get a reply, that means we either are unable to reply, or we don't know how to help.
Mentioning a member of the Hyvä team by name will trigger an alert, which will distract them from what they are doing.
This in turn will only cause the current task to take longer, and thus delay a possible response to your post even further.

If you want to encourage quicker answers, try to improve your message by providing as much context information as possible. By ensuring we don't first have to ask for additional information before being able to answer, you can drastically improve response times.

Basic Magento development questions

We try to help new developers who are not yet familiar with Magento as best we can, but our resources are limited.
For questions that are not related to Hyvä but more about general Magento development, we might have to point you to other resources.

Be welcoming

New members are joining every day. Remember we all started out as n00bs at one point, and try to help them get started with Hyvä. Asking questions is a natural part of learning.

Don't say x, rather say why

We encourage positive, fact-based communication. For example, don't bash about the quality of an extension in public. Remember, we all have to work with frustrating code. Be aware it was the best code the person was able to write at the time. Instead, be precise about what doesn't work, and maybe provide a pointer to how it could be done better.

No harassment

Be friendly, polite, professional and respect boundaries. We welcome people of all origins, genders and orientations equally.

Ask questions in a public channel, not via direct message.

This gives others the opportunity to answer (thus giving you an answer more quickly), and also allows others to read along and learn with you. Don't be afraid to ask questions: nobody knows everything.

Use a direct message if one of the following applies:

  • The message is related to security
  • The message contains private information like access tokens or API keys

Documentation

You are reading it right now. There is a lot more information here!
Try the search in the header or by using the keyboard shortcut (Ctrl-K or Cmd-K).
If you find something missing or wrong, please let us know!

License information

Changing a license domain

Sometimes the domain name attached to a license needs to be changed. There can be many reasons, including the domain being unknown at the time of purchase.
Please email us to change the domain name registered for a license.

Changing ownership of a license

Sometimes a license is purchased by an agency, and it needs to be transferred to the merchant.
This is possible through the Hyvä Portal customer account dashboard on hyva.io.

Changing the implementation partner

On occasion a licensee might decide to change their implementation partner, or they might move to an internal team.
In these cases please email us and let us know, so we can adjust access to resources accordingly.

Contributing

There are different ways to contribute to the Hyvä ecosystem. For where the source code lives and the core contribution process, see Source Code and Contributing.

Compatibility Modules

Compatibility modules add Hyvä support to existing Magento extensions. They are tracked using our public compatibility module tracker. Look for extensions with the "Published" or "Compatible" labels.

If you are an extension vendor, we encourage you to help us maintain the tickets for your extensions, even if you host compatibility modules for your modules outside Hyvä infrastructure.

Be aware that compatibility modules are provided and maintained by the Hyvä community as open source contributions.
A compat module may not work with the latest version of an extension. If you encounter such a case, please be prepared to help maintain the compat module, or look for an alternative way to implement the required feature.

Providing compat modules as an extension vendor

We encourage you to host the compat modules for your extensions on your own infrastructure, and provide access to them through the same means you use to distribute your extensions.
Alternatively you can also choose to maintain the compat modules for your extensions on gitlab.hyva.io

Providing compat modules on gitlab.hyva.io

To host your compatibility modules on Hyvä infrastructure, we will generate a repository for you.
Please provide the following information to help us do so:

  • The original module Magento_Name
  • The original module composer package/name
  • The link to the ticket for the original module in our compat module tracker
  • The email addresses of the developers requiring write access to the compat module repository

After we generate the repository, developers can

  • push to new branches,
  • create merge requests,
  • merge them and
  • tag releases.

The only thing they can't do is push directly to the main branch; everything has to go through a merge request.

Core Contributions

Private Hyvä GitLab access to open issues and merge requests is available to Hyvä partners from a specific tier.