Contributor Guide

Local Development Setup

To setup your development environment, follow the instructions based on the area you want to contribute to:

• For Armada core development: See the Developer Guide for local setup, code structure, and development workflows
• For Armada Operator development: See the Armada Operator repository for setup instructions and development guidelines

Reporting Issues

If you spot a bug or have a feature request, please raise an issue in our main GitHub project:

• https://github.com/armadaproject/armada/issues

Finding Issues to Work On

New to the project? Check out issues tagged with "good first issue". These are curated for newcomers to get familiar with the codebase.

Submitting Pull Requests

When submitting a pull request, make sure to follow these guidelines:

Link to an issue

Make sure your PR references a related issue

Use a separate branch

Keep all pull requests on a separate branch with a proper name

Follow branch naming

Branch names must follow Docker naming conventions (valid ASCII, lowercase and uppercase letters, digits, underscores, periods, and dashes; no leading period or dash; max 128 characters)

Squash small commits

Squash fix-up commits to keep the repository clean (guide)

Signing Off Commits (DCO)

All commits must be signed off using the Developer Certificate of Origin (DCO). This certifies that you have the right to submit your work under the project's open source license.

Use the -s flag when committing:

git commit -s -m 'Your commit message'

The Author and Signed-off-by lines must match. If they don't, the PR will be rejected by the automated DCO check.

If you forgot to sign off and haven't pushed yet, amend your commit:

git commit --amend -s

For more details, see DCO.

Communication

For real-time discussions, Slack channels, GitHub Discussions, and community meetings, see our Community page.

Security

Please report security vulnerabilities to security@gr-oss.io for coordinated disclosure.

License

Armada is licensed under the Apache 2.0 license. See LICENSE for details.