From c7850b9c03eaa1d190362bc0e42e07cbd92d9287 Mon Sep 17 00:00:00 2001 From: SomeCodecat <88855796+SomeCodecat@users.noreply.github.com> Date: Mon, 12 May 2025 11:06:56 +0200 Subject: [PATCH] docs: update contribution guidelines for branch naming and commit message format --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 56b72b5..a7c0bec 100644 --- a/README.md +++ b/README.md @@ -125,13 +125,22 @@ This project is built with a modern tech stack: Contributions are welcome! If you'd like to contribute, please: 1. Fork the repository. -2. Create a new branch (`git checkout -b action/-feature_name`). +2. Create a new branch (`git checkout -b action/-action_name`). 3. Make your changes. 4. Commit your changes (`git commit -m 'action: add some feature'`). -5. Push to the branch (`git push origin action/-feature_name`). +5. Push to the branch (`git push origin action/-action_name`). 6. Open a Pull Request against the `main` branch. -Possible actions are: feat|fix|test|docs|chore|refactor|style|revert +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.