Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (46 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 2.22 KB

Contributing to DevOps Tools Deployment on Kubernetes

Thank you for your interest in contributing to this project! By participating, you help improve the deployment automation and experience for everyone. To ensure a smooth and effective contribution process, please follow these guidelines.

How Can You Contribute?

Reporting Issues

  • Use GitHub Issues to report bugs, unexpected behavior, or feature requests.
  • Provide as much detail as possible: steps to reproduce, logs, environment, and expected vs actual behavior.

Suggesting Enhancements

  • Propose new features or improvements via Issues.
  • Explain the benefit and any potential impact.

Submitting Changes

Contributions are welcome for anything from bug fixes and documentation improvements to new features and pipeline examples.

Contribution Workflow

  1. Fork the repository to your GitHub account.
  2. Create a feature branch off main (or default branch) for your work:
git checkout -b feature/my-awesome-feature
  1. Make sure your code/documentation complies with the project style.
  2. Add or update tests/examples if applicable.
  3. Commit your changes with clear, descriptive messages:
git commit -m "Add support for X feature"
  1. Push your branch to your fork:
git push origin feature/my-awesome-feature
  1. Open a Pull Request against the original repository’s main branch.
  2. Describe your changes and any relevant context in the PR description.
  3. Participate in the review process, responding to feedback and making requested changes.

Code of Conduct

Please note this project adheres to the Contributor Covenant Code of Conduct. By contributing, you agree to uphold this standard to maintain a welcoming and respectful community.

Style Guidelines

  • Follow existing YAML and Markdown formatting.
  • Use clear, concise commit messages.
  • Maintain consistent indentation and spacing.

Additional Resources

  • Familiarize yourself with Kustomize YAML structuring.
  • Review Kubernetes best practices for resource definitions.

We appreciate your contributions and look forward to collaborating with you!