Skip to content

Latest commit

 

History

History
169 lines (101 loc) · 10.5 KB

CONTRIBUTING.md

File metadata and controls

169 lines (101 loc) · 10.5 KB
Raw

AWX

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

Have questions about this document or anything not covered here? Create a topic using the AWX tag on the Ansible Forum.

Table of contents

Things to know prior to submitting code

  • All code submissions are done through pull requests against the devel branch.
  • You must use git commit --signoff for any commit to be merged, and agree that usage of --signoff constitutes agreement with the terms of DCO 1.1.
  • 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 docs.
  • If submitting a large code change, it's a good idea to create a forum topic tagged with 'awx', and talk about what you would like to do or add first. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed.
  • 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 [email protected]

Setting up your development environment

The AWX development environment workflow and toolchain uses Docker and the docker-compose tool, to provide dependencies, services, and databases necessary to run all of the components. It also bind-mounts the local source tree into the development container, making it possible to observe and test changes in real time.

Prerequisites

Docker

Prior to starting the development services, you'll need docker and docker-compose. On Linux, you can generally find these in your distro's packaging, but you may find that Docker themselves maintain a separate repo that tracks more closely to the latest releases.

For macOS and Windows, we recommend Docker for Mac and Docker for Windows respectively.

For Linux platforms, refer to the following from Docker:

Docker Compose

If you're not using Docker for Mac, or Docker for Windows, you may need, or choose to, install the docker-compose Python module separately.

(host)$ pip3 install docker-compose

Frontend Development

See the ansible-ui development documentation.

Fork and clone the AWX repo

If you have not done so already, you'll need to fork the AWX repo on GitHub. For more on how to do this, see Fork a Repo.

Build and Run the Development Environment

See the README.md for docs on how to build the awx_devel image and run the development environment.

Building API Documentation

AWX includes support for building Swagger/OpenAPI documentation. To build the documentation locally, run:

(container)/awx_devel$ make swagger

This will write a file named swagger.json that contains the API specification in OpenAPI format. A variety of online tools are available for translating this data into more consumable formats (such as HTML). http://editor.swagger.io is an example of one such service.

Accessing the AWX web interface

You can now log into the AWX web interface at https://localhost:8043, and access the API directly at https://localhost:8043/api/.

Create an admin user if needed.

Purging containers and images

When necessary, remove any AWX containers and images by running the following:

(host)$ make docker-clean

Pre commit hooks

When you attempt to perform a git commit there will be a pre-commit hook that gets run before the commit is allowed to your local repository. For example, python's black will be run to test the formatting of any python files.

While you can use environment variables to skip the pre-commit hooks GitHub will run similar tests and prevent merging of PRs if the tests do not pass.

If you would like to add additional commit hooks for your own usage you can create a directory in the root of the repository called pre-commit-user. Any executable file in that directory will be executed as part of the pre-commit hooks. If any of the pre-commit checks fail the commit will be halted. For your convenience in user scripts, a variable called CHANGED_FILES will be set with any changed files present in the commit.

What should I work on?

We have a "good first issue" label we put on some issues that might be a good starting point for new contributors.

Fixing bugs and updating the documentation are always appreciated, so reviewing the backlog of issues is always a good place to start.

For feature work, take a look at the current Enhancements.

If it has someone assigned to it then that person is the person responsible for working the enhancement. If you feel like you could contribute then reach out to that person.

NOTES

Issue assignment will only be done for maintainers of the project. If you decide to work on an issue, please feel free to add a comment in the issue to let others know that you are working on it; but know that we will accept the first pull request from whomever is able to fix an issue. Once your PR is accepted we can add you as an assignee to an issue upon request.

If you work in a part of the codebase that is going through active development, your changes may be rejected, or you may be asked to rebase. A good idea before starting work is to have a discussion with us in the Ansible Forum.

If you're planning to develop features or fixes for the UI, please review the UI Developer doc.

Translations

At this time we do not accept PRs for adding additional language translations as we have an automated process for generating our translations. This is because translations require constant care as new strings are added and changed in the code base. Because of this the .po files are overwritten during every translation release cycle. We also can't support a lot of translations on AWX as its an open source project and each language adds time and cost to maintain. If you would like to see AWX translated into a new language please create an issue and ask others you know to upvote the issue. Our translation team will review the needs of the community and see what they can do around supporting additional language.

If you find an issue with an existing translation, please see the Reporting Issues section to open an issue and our translation team will work with you on a resolution.

Submitting Pull Requests

Fixes and Features for AWX will go through the Github pull request process. Submit your pull request (PR) against the devel branch.

Here are a few things you can do to help the visibility of your change, and increase the likelihood that it will be accepted:

  • No issues when running linters/code checkers
    • Python: black: (container)/awx_devel$ make black
  • No issues from unit tests
    • Python: py.test: (container)/awx_devel$ make test
  • Write tests for new functionality, update/add tests for bug fixes
  • Make the smallest change possible
  • Write good commit messages. See How to write a Git commit message.

It's generally a good idea to discuss features with us first by engaging on the Ansible Forum.

We like to keep our commit history clean, and will require resubmission of pull requests that contain merge commits. Use git pull --rebase, rather than git pull, and git rebase, rather than git merge.

Sometimes it might take us a while to fully review your PR. We try to keep the devel branch in good working order, and so we review requests carefully. Please be patient.

When your PR is initially submitted the checks will not be run until a maintainer allows them to be. Once a maintainer has done a quick review of your work the PR will have the linter and unit tests run against them via GitHub Actions, and the status reported in the PR.

Reporting Issues

We welcome your feedback, and encourage you to file an issue when you run into a problem. But before opening a new issues, we ask that you please view our Issues guide.

Getting Help

If you require additional assistance, please submit your question to the Ansible Forum.

For extra information on debugging tools, see Debugging.