Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.71 KB

contribute.md

File metadata and controls

66 lines (42 loc) · 2.71 KB
Raw

ansible-role-uefi-boot-config

Welcome Contributors!

We're delighted that you're interested in contributing to ansible-role-uefi-boot-config! This project aims to provide a robust and efficient Ansible role for configuring UEFI boot settings. Your contributions are vital to making this tool better for everyone.

How Can You Help?

There are many ways you can contribute to this project, including but not limited to:

  1. Code Contributions: Submit bug fixes, improvements, or new features.
  2. Documentation: Enhance or correct existing documentation, or create new guides to help other users.
  3. Issue Reporting: Report bugs, suggest new features, or discuss improvements.
  4. Testing: Help test the role in different environments and configurations.

Getting Started

  1. Fork the Repository: Start by forking the ansible-role-uefi-boot-config repository to your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine:

    git clone https://github.com/[YourUsername]/ansible-role-uefi-boot-config.git

  3. Create a Branch: Create a branch for your changes:

    git checkout -b [your-branch-name]

Making Changes

  1. Follow the Guidelines: Ensure your code adheres to the project's coding standards and best practices.

  2. Update Documentation: If you add new features or change existing behavior, update the documentation accordingly.

  3. Test Your Changes: Test your changes thoroughly to ensure stability and compatibility.

Submitting Your Changes

  1. Commit Your Changes: Commit your changes with a clear and descriptive commit message:

    git commit -m "A brief description of the change"

  2. Push to Your Fork: Push your changes to your forked repository:

    git push origin [your-branch-name]

  3. Create a Pull Request: Go to the original ansible-role-uefi-boot-config repository and create a pull request from your branch. Please provide a clear description of your changes and the benefits they bring.

Stay Involved

  • Review Pull Requests: Look at other contributors' pull requests and provide feedback.
  • Join Discussions: Participate in discussions on issues and pull requests.
  • Stay Up-to-date: Regularly update your fork and local copy with changes from the upstream repository.

Code of Conduct

We strive to foster an inclusive and respectful environment. Please adhere to our Code of Conduct when interacting with the project and its community.

Questions?

If you have any questions or need help, feel free to open an issue for discussion.

Thank you for contributing to ansible-role-uefi-boot-config! Your efforts make a significant impact on the community.