Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 2.33 KB

Contributing to Ansible Docker Container Project

Thank you for considering contributing to the project! I appreciate your time and effort and value your input. The aims of this file are to try to make it easier to contribute and I am happy to try and support contributions. Please bear in mind that overall my aims are mainly to support the successful running of different versions of Ansible on different OS (and architectures).

How Can I Contribute?

Reporting Bugs

  1. Check Current Issues: Before you create a new issue, please search for similar issues in the Issue Tracker.
  2. Create a New Issue: If your issue is new, please include:
    • Title: A succinct title that describes the issue.
    • Description: A detailed description, including steps to reproduce, and environment details (e.g., OS version, Docker version).
    • Logs and Error Messages: Any relevant logs or error messages.

Suggesting Features

If you have an idea to improve the project, submit a feature request in the Issue Tracker and I'll try to respond.

Submitting Pull Requests

  1. Fork the Repository: Create a fork of the repository on GitHub.

  2. Clone Your Fork:

    git clone https://github.com/your-username/your-repo.git
cd your-repo

  3. Create a Branch:

    git checkout -b feature/your-feature-name

  4. Make Changes: Develop your feature or fix in your local repository.

  5. Commit Changes:

    git add .
git commit -m "Description of your changes"

  6. Push Changes:i

    git push origin feature/your-feature-name

  7. Open a Pull Request: Go to the repository on GitHub and open a pull request. Fill out the template provided, if available.

Code Style and Testing

  • Follow Best Practices: Ensure your code follows best practices for Dockerfiles and Ansible.
  • Testing: Thoroughly test your changes. If possible, try building the container locally.
  • Documentation: Update the README.md or other documentation if your changes affect users.

Reviewing and Approval

I make every effort to review pull requests promptly, but sometimes I may be busy or a request may be overlooked, so kindly ask for your patience during the process.