diff options
| author | Chris Houseknecht <chouseknecht@ansible.com> | 2017-08-29 17:11:51 +0200 |
|---|---|---|
| committer | Chris Houseknecht <chouseknecht@ansible.com> | 2017-08-30 03:18:56 +0200 |
| commit | 575495266038b9a92fcea3f90facbd6df8d31d96 (patch) | |
| tree | 1da9a5c51a76f384f09b8bb797feef3748866c67 /README.md | |
| parent | Rename LICENSE to LICENSE.md (diff) | |
| download | awx-575495266038b9a92fcea3f90facbd6df8d31d96.tar.xz awx-575495266038b9a92fcea3f90facbd6df8d31d96.zip | |
Updates CONTRIBUTING and README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 36 insertions, 8 deletions
@@ -1,16 +1,44 @@ [](https://requires.io/github/ansible/awx/requirements/?branch=devel) AWX -============= +=== -AWX provides a web-based user interface, REST API and task engine built on top of -Ansible. +AWX provides a web-based user interface, REST API, and task engine built on top of [Ansible](https://github.com/ansible/ansible). It is the upstream project for [Tower](https://www.ansible.com/tower), a commercial derivative of AWX. -Resources ---------- +To install AWX, please view the [Install guide](./INSTALL.md). -Refer to `CONTRIBUTING.md` to get started developing, testing and building AWX. +To learn more about using AWX, and Tower, view the [Tower docs site](http://docs.ansible.com/ansible-tower/index.html). -Refer to `INSTALL.md` to get started deploying AWX. +Contributing +------------ + +- Refer to the [Contributing guide](./CONTRIBUTING.md) to get started developing, testing, and building AWX. +- All code submissions are done through pull requests against the `devel` branch. +- All contributors 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](./DCO_1_1.md) +- Take care to make sure no merge commits are in the submission, and use `git rebase` vs `git merge` for this reason. +- If submitting a large code change, it's a good idea to join the `#ansible-awx` channel on irc.freenode.net, 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. + +Reporting Issues +---------------- + +If you're experiencing a problem, we encourage you to open an issue, and share your feedback. But before opening a new issue, we ask that you please take a look at our [Issues guide](./ISSUES.md). + +Code of Conduct +--------------- + +We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community#community-code-of-conduct). If you have questions, or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com) + +Get Involved +------------ + +We welcome your feedback and ideas. Here's how to reach us: + +- Join the `#ansible-awx` channel on irc.freenode.net +- Join the [mailing list](https://groups.google.com/forum/#!forum/awx-project) +- [Open an Issue](https://github.com/ansible/awx/issues) + +License +------- + +[Apache v2](./LICENSE.md) -Refer to `LOCALIZATION.md` for translation and localization help. |