mirror of https://github.com/ansible/awx-operator.git synced 2026-05-06 13:22:50 +00:00

Files

Lucas Benedito 9c3f521514 Standardize dev workflow with Makefile includes and developer documentation (#2111 )

* Add standardized Makefile includes and developer documentation

Introduce modular Makefile system (common.mk + operator.mk) for
consistent dev workflows. Standardize CONTRIBUTING.md and
docs/development.md to follow community conventions with clear
separation: contributing guidelines for process, development
guide for technical setup.

- Add common.mk with shared dev workflow targets (make up/down)
- Add operator.mk with AWX-specific variables and targets
- Restructure CONTRIBUTING.md: process, testing requirements, community links
- Expand docs/development.md: customization options table, teardown options,
  Molecule testing, bundle generation via make targets
- Simplify README.md contributing section

Assisted-by: Claude
Signed-off-by: Lucas Benedito <lbenedit@redhat.com>

* Fix DEV_IMG docs example to avoid double-tag issue

Assisted-by: Claude
Signed-off-by: Lucas Benedito <lbenedit@redhat.com>

---------

Signed-off-by: Lucas Benedito <lbenedit@redhat.com>

2026-04-14 12:30:17 +01:00

2.9 KiB

Raw Blame History

Contributing to AWX Operator

Hi there! We're excited to have you as a contributor.

Have questions about this document or anything not covered here? Please file an issue at https://github.com/ansible/awx-operator/issues.

Things to know prior to submitting code

All code submissions are done through pull requests against the devel branch.
All PRs must have a single commit. Make sure to squash any changes into a single commit.
Take care to make sure no merge commits are in the submission, and use git rebase vs git merge for this reason.
If collaborating with someone else on the same branch, consider using --force-with-lease instead of --force. This will prevent you from accidentally overwriting commits pushed by someone else. For more information, see git push --force-with-lease.
We ask all of our community members and contributors to adhere to the Ansible code of conduct. If you have questions, or need assistance, please reach out to our community team at codeofconduct@ansible.com.

Setting up your development environment

See docs/development.md for prerequisites, build/deploy instructions, and available Makefile targets.

Submitting your work

From your fork's devel branch, create a new branch to stage your changes.

git checkout -b <branch-name>

Make your changes.
Test your changes (see Testing below).
Commit your changes.

git add <FILES>
git commit -m "My message here"

Create your pull request.

Note

: If you have multiple commits, make sure to squash them into a single commit before submitting.

Testing

All changes must be tested before submission:

Linting (required for all PRs): make lint
Molecule tests (recommended): The operator includes a Molecule-based test environment for integration testing. See the Testing section in docs/development.md for detailed instructions on running tests locally.

Reporting Issues

We welcome your feedback, and encourage you to file an issue when you run into a problem at https://github.com/ansible/awx-operator/issues.

Getting Help

Forum

Join the Ansible Forum for questions, help, and development discussions. Search for posts tagged with awx-operator or start a new discussion.

Matrix

For real-time conversations:

#awx:ansible.com — AWX and AWX Operator discussions
#docs:ansible.im — Documentation discussions

2.9 KiB Raw Blame History