Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 2.73 KB

CONTRIBUTE.md

File metadata and controls

80 lines (57 loc) · 2.73 KB
Raw

Contributing to OmniOpenCon2024

We welcome and encourage contributions to the OmniOpenCon 2024 workshop repository! Below are guidelines and instructions to help you get started.

How to Contribute

  1. Fork the Repository:

    • First, fork the repository to your own GitHub account.
    • You can do this by clicking the "Fork" button at the top right of the repository page.

  2. Clone the Fork:

    • Clone your fork to your local machine using the following command: 
      git clone https://github.com/<your-username>/omniopencon2024.git
cd omniopencon2024

  3. Create a New Branch:

    • Create a new branch for your contribution: 
      git checkout -b my-new-feature

  4. Make Changes:

    • Make sure your changes are related to the issue or feature you want to improve.
    • Follow any style guidelines used in the repository (check for existing conventions in the code).

  5. Test Your Changes:

    • Ensure that all changes are tested and that the playbooks/roles you edit still function as expected.
    • If you're adding new functionality, try to write tests where possible.

  6. Commit Your Changes:

    • Make atomic commits, ideally one per feature or fix. Write meaningful commit messages. 
      git commit -m "Add feature X"

  7. Push to Your Fork:

    • Push your branch to your fork on GitHub: 
      git push origin my-new-feature

  8. Submit a Pull Request:

    • Once you're happy with your changes, go to the original repository and open a pull request (PR).
    • Provide a clear description of what changes you've made and any relevant issue numbers.

Contribution Guidelines

  1. Code of Conduct:

  2. Use Proper Git Practices:

    • Create a new branch for each feature or bug fix.
    • Write clear, concise commit messages.
    • Rebase your changes onto the main branch before submitting your pull request if necessary.

  3. Code Style:

    • Follow any existing coding style in the repository.
    • Use YAML linting tools for Ansible playbooks to ensure consistency.

  4. Be Respectful in Reviews:

    • We appreciate all contributions, and we encourage open and constructive feedback during code reviews.

Issues and Feature Requests

  • Feel free to submit any issues or feature requests by opening a GitHub issue.
  • Before submitting an issue, check if the same or similar issue already exists to avoid duplicates.

Questions?

If you have any questions, feel free to reach out via issues or discussions. We’re happy to help!