DHBW-WE/MeetUp
5
0
Fork 0
Code Issues 7 Pull requests 5 Projects 1 Releases 5 Packages 1 Wiki Activity Actions

docs: update contribution guidelines to standardize branch naming and commit message format
All checks were successful
container-scan / Container Scan (pull_request) Successful in 1m13s
Details
docker-build / docker (pull_request) Successful in 2m40s
Details

Browse source
This commit is contained in:
Maximilian Liebmann 2025-05-12 10:48:53 +02:00
parent 92af2bbb7c
commit 9aced187eb
1 changed files with 15 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -125,11 +125,22 @@ This project is built with a modern tech stack:
Contributions are welcome! If you'd like to contribute, please: Contributions are welcome! If you'd like to contribute, please:
1. Fork the repository. 1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name` or `fix/your-bug-fix`). 2. Create a new branch (`git checkout -b <action>/<issue#>-action_name`).
3. Make your changes. 3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`). 4. Commit your changes (`git commit -m '<action>: add some feature'`).
5. Push to the branch (`git push origin feature/your-feature-name`). 5. Push to the branch (`git push origin <action>/<issue#>-action_name`).
6. Open a Pull Request against the `main` (or `develop`) branch. 6. Open a Pull Request against the `main` branch.
Possible actions are:
*feat* -> Feature added
*fix* -> Fixed a bug
*test* -> Modified or added tests
*docs* -> Modified documentation
*chore* -> changes to non code files (workflows, lock files, ...)
*refactor* -> rewritten code without changing functionality
*style* -> code style (yarn format)
*revert* -> reverts a previous commit
Please ensure your code adheres to the project's coding standards (e.g., run linters/formatters if configured) and that any database schema changes are accompanied by a Prisma migration. Please ensure your code adheres to the project's coding standards (e.g., run linters/formatters if configured) and that any database schema changes are accompanied by a Prisma migration.