Add contribution guidelines #168
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
memeToasty
reviewed
Nov 9, 2023
TomRomeo
reviewed
Nov 10, 2023
4KevR
reviewed
Nov 12, 2023
Co-authored-by: Kevin Wiesner <[email protected]> Signed-off-by: Julian Herzog <[email protected]>
|
[Kioku Frontend] Kudos, SonarCloud Quality Gate passed!
|
|
[Kioku Backend] Kudos, SonarCloud Quality Gate passed!
|
TomRomeo
approved these changes
Nov 12, 2023
4KevR
approved these changes
Nov 12, 2023
darmiel
reviewed
Nov 15, 2023
Comment on lines
+22
to
+33
| - `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. |
There was a problem hiding this comment.
Suggested change
| - `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. | |
| - `type`: What is the purpose of your changes? Currently we are using the following prefixes | |
| - `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. |
|
|
||
| - 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. |
There was a problem hiding this comment.
Suggested change
| - 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. | |
| - A corresponding translation in English and German should be provided for each text. If you do not speak German, we will help you with the translation. |
|
|
||
| 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 |
There was a problem hiding this comment.
Suggested change
| # Index | |
| # Table of Contents |
|
|
||
| When committing changes, please write your messages according to the following convention: | ||
|
|
||
| This commit will `Your commit message` |
There was a problem hiding this comment.
Suggested change
| This commit will `Your commit message` | |
| `This commit will ...` |
|
|
||
| This commit will `Your commit message` | ||
|
|
||
| Write the first letter of your message in upper case and the rest in lower case. |
There was a problem hiding this comment.
Suggested change
| Write the first letter of your message in upper case and the rest in lower case. | |
| Write the first letter of your message in upper case. |
| - 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. | |
JJthere
requested changes
Nov 27, 2023
|
|
||
| If you make changes to the frontend, please ensure the following points. | ||
|
|
||
| - Please run Prettier before commiting changes. |
There was a problem hiding this comment.
Suggested change
| - Please run Prettier before commiting changes. | |
| - Please run `Prettier` before committing changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pr adds a contribution guideline to make participation in the project easier and more transparent.