Skip to content

Update CONTRIBUTING.md #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nidrax merged 1 commit into from
Feb 7, 2026
Merged

Update CONTRIBUTING.md #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
### 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.