Contributing

To contribute to the repository you should follow the guidelines:

Open an issue

When opening a new issue for a bug/feature, explain what has to be done or what the problem is. Make sure to link the project board when making the issue, so GitHub automatically changes the issue's status in the board and so we can follow the progress on different issues more easily.

Create a new branch from the main branch

Before starting your work on the code, make sure to branch out from the latest main branch.

Commit your code there

Make small and understandable commits to the feature branch you just created

Push your branch

Try to make your pull requests smaller so the code review is easier. This can be more easily managed by making issues on smaller matters (e.g. NOT Make homepage, but YES Implement headerbar)

Create a pull request to main branch

When you push your branch GitHub will suggest to make a PR to main. Do it, explaining shortly what have you done.

Link PR to ISSUE

In the description, you should write one of the following keywords, depending on which matches to the situation the best, followed by the issues number (#).

• close
• closes
• closed
• fix
• fixes
• fixed
• resolve
• resolves
• resolved

Examples: fix #21; close #99; resolves #2

Make pull request

Make your pull request