Contributing

Contributing

Thank you for considering a contribution to RAVEN C2 Framework. This page explains the branching model and basic workflow for submitting changes.

Branching Model

Branch	Purpose	Who pushes here
main	Stable releases for normal usage	Maintainer only (via merge)
dev	Active development, contributions, pull requests	Contributors
master	Owner/admin-only commits	MatrixTM26 only

For normal usage, clone main:

git clone --branch main https://github.com/MatrixTM26/RAVEN.git

To contribute, clone dev, make your changes, and open a pull request against dev:

git clone --branch dev https://github.com/MatrixTM26/RAVEN.git
cd RAVEN.git
git checkout -b feature/my-change

Submitting a Pull Request

1. Fork the repository (or clone dev directly if you have access).
2. Create a feature branch off dev: feature/<short-description> or fix/<short-description>.
3. Make your changes, keeping commits focused and descriptive.
4. Test your build locally for your platform (see Installation and Build).
5. Push your branch and open a pull request targeting dev.
6. Reference any related issue numbers in your PR description.

Code Style

• Follow standard Java conventions (PascalCase for classes, camelCase for methods/variables).
• Keep new features modular and consistent with the existing interface separation (Web / CLI / GUI).
• Document any new CLI flags or config keys in the relevant wiki page when you add them.

Code of Conduct

This project maintains a Code of Conduct. Please be respectful and constructive in issues, discussions, and pull requests.

Reporting Bugs

Open an issue on the Issues tracker with:

• Your OS and Java version
• Exact command used to launch the JAR
• Steps to reproduce
• Expected vs actual behavior

License Reminder

RAVEN C2 is licensed under AGPL-3.0. Any modified version that you distribute or run as a network service must also make its source code available under the same license. Review the LICENSE file before redistributing.

See Also

• Home
• Installation and Build