vikingowl
34f2f1bad8
- Add branching workflow: main -> dev -> feature/* - Document that PRs should target dev branch - Add release workflow documentation
1.7 KiB
1.7 KiB
Contributing
Thanks for your interest in Vessel.
Where to Contribute
- Issues: Open on GitHub at https://github.com/VikingOwl91/vessel
- Pull Requests: Submit via GitHub (for external contributors) or Gitea (for maintainers)
Branching Strategy
main (protected - releases only)
└── dev (default development branch)
└── feature/your-feature
└── fix/bug-description
- main: Production releases only. No direct pushes allowed.
- dev: Active development. All changes merge here first.
- feature/*: New features, branch from
dev - fix/*: Bug fixes, branch from
dev
Workflow
- Fork the repository (external contributors)
- Clone and switch to dev:
git clone https://github.com/VikingOwl91/vessel.git cd vessel git checkout dev - Create a feature branch:
git checkout -b feature/your-feature - Make changes with clear, focused commits
- Test your changes
- Push and create a PR targeting
dev:git push -u origin feature/your-feature - Open a PR from your branch to
dev
Commit Messages
Follow conventional commits:
feat:New featuresfix:Bug fixesdocs:Documentation changesrefactor:Code refactoringtest:Adding testschore:Maintenance tasks
Guidelines
- Keep changes focused and small
- UI and UX improvements are welcome
- Vessel intentionally avoids becoming a platform
- If unsure whether something fits, open an issue first
Development Setup
See the Development Wiki for detailed setup instructions.