Skip to content
This repository has been archived by the owner on Jun 17, 2022. It is now read-only.

Latest commit

 

History

History
45 lines (31 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.49 KB
Raw

How to contribute

We welcome contributions from the public. However there are some guidelines to follow:

  1. We cannot accept new language versions and translations from community, this is because:
    • Some expressions used within the app are strictly coupled with Finnish law and thus must meet it's requirements
    • There's also a lot of domain specific terminology involved which must be handled by THL's board of experts
    • Small typo fixes can be processed manually but better way to report those is to raise an issue. We can then manually credit changes to issue's original author
  2. Prior to committing to work, create an issue describing a problem, bug or enhancement you would to like to work on
  3. Wait for discussion on the issue and how it should be solved
  4. Wait for main contributors of the repository to handle the issue and clear it for implementation
  5. Embrace the feedback and be patient. We are working as fast as we can to improve Koronavilkku and community's help is much appreciated

Contribution license

By sending a pull request, you agree and acknowledge that your contribution will be licensed under the main license of the project (EUPL-1.2). Notwithstanding the foregoing, you further agree that THL (Finnish Institute for Health and Welfare) may also redistribute the application, along with your contribution, via an application store under their separate Terms of Use as available at https://koronavilkku.fi/en/terms/ and as amended from time to time at THL's sole discretion.

Issues

The issue tracker is the preferred channel for reports and queries.

Pull requests

Our team will review the pull requests and contributors will get credit. You can see all contributors in AUTHORS.md.

Commit message styleguide

We follow The seven rules of a great Git commit message.

TL;DR

  • Title line max 50 characters
  • Single empty line between title and detailed description when description is needed
  • Explain what and why vs. how
  • Use the imperative mood in the title line
    • ✔️ Refactor subsystem X for readability
    • ✔️ Update getting started documentation
    • ✔️ Remove deprecated methods
    • ✔️ Release version 1.0.0
    • ❌ Fixed bug with Y
    • ❌ Changing behavior of X
    • ❌ More fixes for broken stuff
  • Attach issue tracker references at bottom after single empty line Resolves: #123 or See also: #456, #789