Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

57 lines (43 loc) · 2.78 KB
Raw

Thank you for considering contributing to our project!

This project has a lot of room for improvement and a lot of features to be added and with your help we can implement more of our ideas.

What we expect from a contributor?

The project is mainly written on Flask and Svelte, so knowledge in at least one of those is the first requirement. You must be fluent with Git and Github, as well as knowing the basics of Scrum process for managing work. We are currently using Ora for tracking tasks and progress, so if you want to join, you should create an account there.

How to become a contributor

If you meet the requirements and want to become a contributor, you can send an email to ognian@baruh.net or gabrielay2002@gmail.com. In that email you should explain us what part of the project you can help us with (Flask or Svelte) as well as why you want to join. If you are elected you will receive an email about that, as well as invitations for the project in Ora and the repository in Github.

Rules

  1. We are following GitHub Flow as a braching strategy. More information about the strategy can be found in the README.md
  2. One task in Ora = one pull request in Github. The pull requests must be with the same name as the tasks in Ora.
  3. Branches can be merged only by the project owners (Gabriela Yoncheva or Ognian Baruh).
  4. Tests are mandatory - integration tests for Flask and manual/automation tests for Svelte. Contact the project owners for more information about tests.
  5. Project is tested on every push. If the tests don't pass, you must go back and fix the code. If you think that the tests should be modified contact the project owners and other contributors for their opinion.

Code requirements

Pull requests formatting

  • The name of the task in Ora and the name of the pull request should be the same
  • In the message explain what has been changed in the code
  • Add reviewers. The project owners are mandatory reviewers and you can add other contributors
  • Add assigness. In the most cases it will only be you
  • Add labels
  • Pull requests that are not following the rules won't be accepted

Ora Abbreviations

  • "BE" - Back-end
  • "FE" - Front-end
  • "TS" - Tests
  • "T" - Team (Usually tasks that require team effort and team discussion)

Commit Messages Formatting

  • [Update] "commit message"
  • [Remove] "commit message"
  • [Fix] "commit message"
  • [New] "commit message"