From c2f18de9aa0080637b9c5ae34db798cf293cac80 Mon Sep 17 00:00:00 2001 From: Julian <66846059+Julian702@users.noreply.github.com> Date: Thu, 9 Nov 2023 11:36:19 +0100 Subject: [PATCH 1/3] Add contribution guidelines --- CONTRIBUTING.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..627078d7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# Welcome to Kioku's contribution guidelines + +We are delighted that you want to help us to make Kioku even better! To make this as easy and transparent as possible for you, we have summarized the guidelines we follow in this document. Don't be afraid to make a mistake, we appreciate every contribution. If anything is still unclear to you, don't hesitate to contact us and ask for help. We look forward to your contribution to the project and are always happy to help. + +# Index + +1. [Git](#git) + - [Branches](#branches) + - [Commits](#commits) +2. [Backend](#backend) +3. [Frontend](#frontend) + +# Git + +### Branches + +When creating branches, we follow the following pattern: + +`[type]/[area]/[individual name]` + +- `type`: What is the purpose of your changes? Currently we are using the following tags + - feature: for implementing new features + - fix: for bugfixes + - hotfix: for urgent fixes such as security vulnerabilities and more important bugs that severely affect the usability of our application + - refactor: for changes that only improve the source code and have little or no impact on the functionality of Kioku + - test: for everything concerning testing + - deployment: for all deployment topics + - docs: for updating the docs +- `area`: Which area of the application do the changes affect? If none or both apply to your changes, simply leave it out. + - frontend + - backend +- `individual name`: This is where you should try to summarize your changes as short and precise as possible. If you need several words, separate them with a dash and write everything in lower case. + +### Commits + +When committing changes, please write your messages according to the following convention: + +This commit will `Your commit message` + +Write the first letter of your message in upper case and the rest in lower case. + +### Pull requests + +When you open a pull request, remember to label it and link the corresponding issue. Pull requests should always concern only one specific subject. Please use the template and fill in the required information. + +# Backend + +# Frontend + +If you make changes to the frontend, please ensure the following points. + +- Please run Prettier before commiting changes. +- Stories should be available for each component and its different variants. +- A corresponding translation in English and German should be provided for each text. If you do not speak German, we will support you with the translation. + +If you are not familiar with any of these points, take a look at our [frontend documentation](./docs/frontend_development.md) or ask us for help. From 7d3055b93b691b5a22223614b08ab1ea5e1787d8 Mon Sep 17 00:00:00 2001 From: Julian <66846059+Julian702@users.noreply.github.com> Date: Sat, 11 Nov 2023 12:20:10 +0100 Subject: [PATCH 2/3] Apply pr feedback --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 627078d7..7915a705 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,7 @@ We are delighted that you want to help us to make Kioku even better! To make thi 1. [Git](#git) - [Branches](#branches) - [Commits](#commits) + - [Pull Requests](#pull-requests) 2. [Backend](#backend) 3. [Frontend](#frontend) From 5ec996ec5a63fe977cc23e9736009bf9de866673 Mon Sep 17 00:00:00 2001 From: Julian Herzog <66846059+Julian702@users.noreply.github.com> Date: Sun, 12 Nov 2023 15:43:19 +0100 Subject: [PATCH 3/3] Update CONTRIBUTING.md Co-authored-by: Kevin Wiesner <50447092+4KevR@users.noreply.github.com> Signed-off-by: Julian Herzog <66846059+Julian702@users.noreply.github.com> --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7915a705..7a910761 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,6 +46,13 @@ When you open a pull request, remember to label it and link the corresponding is # Backend +If you make changes to the backend, please keep the following points in mind. + +- Export new proto definitions with every change via `make proto` in the corresponding service directory +- Make yourself familiar with the `helper` and `converter` packages of the project as they contain standards for serializing/deserializing objects, error definition, JWT handling and ID naming +- Document API changes in the `bruno` project inside `/backend/api-documentation` + +If you are not familiar with any of these points, take a look at our [backend documentation](./docs/backend_development.md) or ask us for help. # Frontend If you make changes to the frontend, please ensure the following points.