mirror of
https://github.com/ansible/awx-operator.git
synced 2026-05-06 21:32:52 +00:00
9c3f521514
* 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>
59 lines
2.9 KiB
Markdown
59 lines
2.9 KiB
Markdown
# 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](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](https://git-scm.com/docs/git-push#git-push---force-with-leaseltrefnamegt).
|
|
- We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions, or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com).
|
|
|
|
## Setting up your development environment
|
|
|
|
See [docs/development.md](docs/development.md) for prerequisites, build/deploy instructions, and available Makefile targets.
|
|
|
|
## Submitting your work
|
|
|
|
1. From your fork's `devel` branch, create a new branch to stage your changes.
|
|
```sh
|
|
git checkout -b <branch-name>
|
|
```
|
|
2. Make your changes.
|
|
3. Test your changes (see [Testing](#testing) below).
|
|
4. Commit your changes.
|
|
```sh
|
|
git add <FILES>
|
|
git commit -m "My message here"
|
|
```
|
|
5. Create your [pull request](https://github.com/ansible/awx-operator/pulls).
|
|
|
|
> **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](https://ansible.readthedocs.io/projects/molecule/)-based test environment for integration testing. See the [Testing section in docs/development.md](docs/development.md#testing) 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](https://github.com/ansible/awx-operator/issues).
|
|
|
|
## Getting Help
|
|
|
|
### Forum
|
|
|
|
Join the [Ansible Forum](https://forum.ansible.com) for questions, help, and development discussions. Search for posts tagged with [`awx-operator`](https://forum.ansible.com/tag/awx-operator) or start a new discussion.
|
|
|
|
### Matrix
|
|
|
|
For real-time conversations:
|
|
|
|
* [#awx:ansible.com](https://matrix.to/#/#awx:ansible.com) — AWX and AWX Operator discussions
|
|
* [#docs:ansible.im](https://matrix.to/#/#docs:ansible.im) — Documentation discussions
|