2.5 KiB
Contributors Guide
For who is this guide?
This guide is meant for users who want to contribute to the codebase of Universal Android Debloater Next Generation, whether that is the application code or the "database"-file for adding packages. To keep all processes streamlined and consistent, we're asking you to stick to this guide whenever contributing.
Even though the guide is made for contributors, it's also strongly recommended that the UAD-ng team sticks to these guidelines. After all, we're a prime example.
What are the guidelines?
Branching strategy
As for our branching strategy, we're using Trunk-Based Development.
In short, there's one trunk branch named main (master). Apart from main/master there can be different short-lived branches, such as:
- Features (
feature/*) - Fixes (
hotfix/*or simplyfix/*) - Dependency updates (
deps/*) - Etc.
Do mind that these branch names do only not apply to the addition of packages; for that, we use the following scheme: [issue number][issue title]. This can be done automatically too.
This is how it looks like and works:
Syncing branches
If you want to back-port (GitHub's "Update" and "Sync" buttons) from upstream main to any other branch (for testing purposes, or any other reasonable case), it's recommended that you rebase rather than merge the changes.
Don't apply changes to/from arbitrary branches, that's a recipe for chaos! If you encounter a situation where it's absolutely necessary to sync non-main branches, whether to merge or rebase should be decided by the UAD-ng team (with some contributor feedback) on a case-by-case basis.
Commit messages
As for commits, we prefer using Conventional Commit Messages. When working in any of the branches listed above (if there's an existing issue for it), close it using a closing keyword. For more information regarding Conventional Commit Messages, see https://www.conventionalcommits.org/en/v1.0.0/ as well.