Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.77 KB

CONTRIBUTORS.md

File metadata and controls

54 lines (35 loc) · 2.77 KB
Raw

How to Contribute

This is a very young project, and the codebase is moving quickly -- but there are plenty of ways to help. This document provides some guidelines for when you're ready to ask questions, file issues, submit code, or submit examples of working Ansible Container projects.

For additional information about contributing to the project, or to review our Code of Conduct and our Contributor's License Agreement, please visit [Community Information and Contributing](<https://docs.ansible.com/ansible-container/community/index.html).

Ask questions and file issues

Please use the GitHub issue tracker for all issues with, and questions about, the project. We will respond to issues as quickly as possible.

When filing an issue, observing the following guidelines will lead to a quicker response:

  • Search existing issues to see if someone else has asked the same question or raised a similar issue.
  • State the question or nature of the issue clearly in the title.
  • When reporting a bug, please complete the issue template with as much detail as possible. The template asks for information about your environment, the command you executed, stracktraces, etc. Answer each question thoroughly, and include code snippets, screen shots, or anything you feel will help a developer reproduce and troubleshoot the issue.

Contribute code

Code submissions are accepted via pull requests, and they are always welcome! We may not accept them all, but we are always happy to review and discuss them with you.

Before submitting a large pull request for a new feature, we suggest joining the Ansible Container Mailing List, and submitting a topic to discuss the feature prior to submission.

We reserve the right to reject submissions that are not a good fit for the project or not in keeping with the intended direction of the project. If you are unsure as to whether a feature is a good fit, take the time to start a discussion on the mailing list.

Please observe the following when submitting a PR:

  • Follow the gitflow branching model.
  • Submit requests to the develop branch.
  • Include unit and integration tests for new features.
  • Document new features in docs/rst.
  • Limit the scope of a submission to a single feature or bug fix.
  • Ensure tests are passing.

Running tests

See test/README.md

Provide examples

Examples of working Ansible Container playbooks are very useful! Please feel free to provide pull requests linking to examples from your own repos in EXAMPLES.md, or submit them to ansible-container-examples.

 

Thanks for trying out Ansible Container!