We love your work. We want to make it as easy as possible for you to contribute to our project. This document describes the steps you need to take to contribute to our project.
- Feature branches should be created from the 'master' branch, based on the target deployment.
- Use the convention
[feat/update/fix/]SVA-..., aligning with the corresponding Jira ticket, if existing. - include
SVA-[Ticket-Number]at the bottom of the commits message description, if existing. - Pull Requests (PRs):
- Description: Provide a detailed description, preferably with supporting images
- Assignees: Assign yourself as the PR owner
- Reviewers: Add two colleagues for peer review
- Labels: Attach the appropriate label to categorize the PR
- Jira, if you have access
- Assign the category (e.g., 'Internal Review') within Jira
- Select a person for review
- Set a due date
- Add a comment for additional context
Please pay attention to detailed and meaningful commit messages.
A good summary, thx to: https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/
- Specify the type of commit:
- feat: The new feature you're adding to a particular application
- fix: A bug fix
- style: Feature and updates related to styling
- refactor: Refactoring a specific section of the codebase
- test: Everything related to testing
- docs: Everything related to documentation
- chore: Regular code maintenance.
- Separate the subject from the body with a blank line
- Your commit message should not contain any whitespace errors
- Remove unnecessary punctuation marks
- Do not end the subject line with a period
- Capitalize the subject line and each paragraph
- Use the imperative mood in the subject line
- Use the body to explain what changes you have made and why you made them.
- Do not assume the reviewer understands what the original problem was, ensure you add it.
- Do not think your code is self-explanatory
- Follow existing commit conventions, for example: https://www.conventionalcommits.org/en/v1.0.0/