Skip to content

Contributing to OpenInfraQuote

We welcome contributions from the community! This document will guide you through the process of contributing to OpenInfraQuote.

Code of Conduct

Our community follows a Code of Conduct that establishes expectations for participation. We expect all contributors to adhere to this code to ensure a positive experience for everyone involved.

How to Contribute

There are many ways to contribute to OpenInfraQuote:

  • Reporting bugs
  • Suggesting features
  • Improving documentation
  • Writing code
  • Helping users in discussions

Getting Started

  1. Fork the repository: Fork the OpenInfraQuote repository on GitHub.

  2. Clone your fork: 

    git clone https://github.com/YOUR_USERNAME/openinfraquote.git
cd openinfraquote

  3. Set up your development environment: Follow the instructions in the Build from Source guide.

  4. Create a branch: 

    git checkout -b my-feature-branch

  5. Make your changes: Implement your feature or bug fix.

  6. Update documentation: Update any relevant documentation.

  7. Commit your changes: 

    git commit -m "Your descriptive commit message"

  8. Push to your fork: 

    git push origin my-feature-branch

  9. Open a pull request: Go to the OpenInfraQuote repository and open a pull request from your branch.

Pull Request Process

  1. Make sure your PR includes:

    • A clear description of the changes
    • Any relevant issue numbers
    • Updated documentation if necessary

  2. Wait for CI checks to pass.

  3. Address any feedback from maintainers.

  4. Once approved, a maintainer will merge your PR.

Development Guidelines

Code Style

  • Use meaningful variable and function names
  • Write clear comments and documentation
  • Keep functions focused and small

Documentation

  • Update relevant documentation for any changes
  • Use clear and concise language
  • Include examples where appropriate

Feature Requests

Have an idea for a new feature? Here's how to propose it:

  1. Check existing issues to see if it's already been suggested
  2. Open a new GitHub Issue
  3. Describe the feature in detail
  4. Explain how it would benefit users
  5. If possible, outline how it might be implemented

Bug Reports

Found a bug? Please help us fix it:

  1. Check existing issues to see if it's already been reported
  2. Open a new GitHub Issue
  3. Provide detailed steps to reproduce the bug
  4. Include any error messages or logs
  5. Mention your operating system and OpenInfraQuote version

Getting Help

If you need help with contributing:

Thank you for considering contributing to OpenInfraQuote!