Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

23 lines (19 loc) · 2.05 KB
Raw

Contributing

Opening an Issue

  • If you experience or notice an error, bug, documentation issue, please feel free to;
    1. Open a GitHub Issue against the project.
    2. Provide details and logs in the description on how to reproduce the issue.
    3. Provide details of the operating system type and version, custom configurations, versions of applications that are displaying the issue, if applicable.

Opening a Pull Request

  • If you would like to contribute to the project, please feel free to create a Pull Request;
    1. Fork the upstream repository.
    2. Clone the recently forked repository to your workstation.
    3. Navigate into the repository and create a branch and checkout into the new branch.
    4. Make changes that you would like to contribute then add and commit changes to the repository.
    5. Push the changes you made in the local branch to your remote fork.
    6. Create a Pull Request against the upstream repository.
  • When working on ansible playbooks, a recommendation would be to leverage Ansible Lint, which is a linter that checks playbooks for practices that could be improved.