From d6974a42fd914f7b56e1238c4e24890ca6e0b34e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Pra=C5=BAmo?= Date: Sat, 7 Feb 2026 20:57:04 +0100 Subject: [PATCH] Update CONTRIBUTING.md with info about the NO_SW_CHANGE tag for workflows --- CONTRIBUTING.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03032257a..4c1b881b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,18 @@ ## Branching Model We use the following branch structure to manage development: - `trunk`: This is the development branch for Besprited. All new features and bug fixes are merged here first. -- `ls-develop`: This branch tracks the latest changes from LibreSprite's `master` branch. - We periodically merge changes from LibreSprite into our `trunk` branch to stay up-to-date with their developments. - ***Any fixes to bugs shared with common LibreSprite codebase should be made against `LibreSprite:master` directly.*** +- `ls-develop`: This branch should track the latest changes from LibreSprite's `master` branch. + We periodically merge changes from LibreSprite into our `trunk` branch to stay up-to-date with their developments + and our repo maintainers use this branch as a base to create any feature or bug fix branches that are shared with LibreSprite's codebase. -Feature and fix branches should follow the naming convention: `username/short-description`, for example: `nidrax/v8-build-fix-windows`. \ No newline at end of file +### Note for repo collaborators: +User branches for features and fixes created directly against the `veritaware:Besprited` repository should follow the naming convention: +`username/short-description`, for example: `nidrax/v8-build-fix-windows`. + +## Commit Messages and Pull Requests +When committing changes, follow these guidelines: +- Use imperative mood in the subject line (e.g., "Fix bug" instead of "Fixed bug" or "Fixes bug"). +- Keep the subject line concise (50 characters or fewer) and provide a more detailed description in the body if necessary. +- If the commit or pull request closes an issue, include a reference to the issue number in the commit message or pull request description (e.g., "Fixes #123"). +- If the commit or pull requst does not introduce changes to the source code itself (e.g., documentation, helper scripts, issue templates, etc.) + add the `NO_SW_CHANGE` line to the end of the commit message or pull request description body to skip GitHub build workflows. \ No newline at end of file