Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (40 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 2.19 KB

🤝 Contributing to POps-Rox

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to projects in the POps-Rox organization. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

📜 Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

🚀 How Can I Contribute?

🐛 Reporting Bugs

Before creating bug reports, please check existing issues to avoid duplicates. When you create a bug report, include as many details as possible using our bug report template.

✨ Suggesting Features

Feature suggestions are tracked as GitHub issues. Create an issue using the feature request template and provide:

  • A clear and descriptive title
  • A detailed description of the suggested feature
  • Any possible alternatives you've considered
  • Why this feature would be useful

🔧 Pull Requests

  1. Fork the repository
  2. Create a feature branch from main: git checkout -b feature/my-feature
  3. Make your changes with clear, descriptive commit messages
  4. Test your changes thoroughly
  5. Push to your fork: git push origin feature/my-feature
  6. Open a Pull Request against main

📝 Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests after the first line

🏗️ Development Setup

See the repository's README for specific setup instructions.

📋 Style Guidelines

Terraform

  • Run terraform fmt before committing
  • Use meaningful variable and resource names
  • Include descriptions for all variables and outputs
  • Provide examples in an examples/ directory

General

  • Follow the existing code style in the project
  • Comment your code where the intent isn't obvious
  • Update documentation alongside code changes

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.