Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 5.39 KB

CONTRIBUTING.md

File metadata and controls

101 lines (71 loc) · 5.39 KB

Contributing to Terrateam

First off, thank you for considering contributing to Terrateam! We're excited to have you as part of our open-source community. By contributing to this project, you help improve the quality and capabilities of Terrateam, and we genuinely appreciate your support.

How Can You Contribute?

Reporting Issues

If you encounter any bugs or issues while using Terrateam, please report them through our GitHub Issues page. When reporting an issue, please include as much detail as possible, such as the steps to reproduce the issue, the environment in which it occurred, and any relevant logs or screenshots.

Documentation Improvements

We welcome improvements to our documentation! Whether it’s fixing a typo, clarifying instructions, or adding new information, your contributions help make Terrateam easier to use for everyone. Please feel free to submit pull requests with documentation updates.

Community Support

Helping other users by answering questions, participating in discussions, and sharing your experiences with Terrateam is a valuable contribution. You can participate in our GitHub Discussions or join our Slack Community to connect with other users and developers.

Bug Fixes and New Features

While we encourage pull requests for bug fixes or new features, please note that our codebase is written with specific styles. As a result, we may need to rewrite contributions to ensure consistency across the project. Please don’t be offended, your input is still highly valued, and we appreciate your effort to improve Terrateam.

Contributing Code

Getting Started

  1. Fork the Repository : Start by forking the Terrateam repository .

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

git clone https://github.com/your-username/terrateam.git
  1. Create a Branch : Create a new branch for your work.
git checkout -b my-feature-branch

  1. Make Your Changes : Implement your bug fix, feature, or documentation update.

  2. Commit Your Changes : Write clear and concise commit messages following the format below.

ISSUE_NUMBER ACTION_TYPE Short description of the change

Use one of the following action types:

  • ADD: For new features
  • FIX: For bug fixes
  • REFACTOR: For code restructuring that doesn’t add new features or fix bugs

Examples:

123 ADD Support for multi-region deployments
234 FIX Resolve cache issue on deployment
345 REFACTOR Move user authentication to middleware

git commit -m "123 ADD Support for multi-region deployments"
  1. Push Your Branch : Push the branch to your forked repository.
git push origin my-feature-branch
  1. Submit a Pull Request : Open a pull request from your branch to the main branch of the Terrateam repository. Make sure the pull request title follows the same format as your commit messages:
ISSUE_NUMBER ACTION_TYPE Short description of the change

Use one of the following action types:

  • ADD: For new features
  • FIX: For bug fixes
  • REFACTOR: For code restructuring that doesn’t add new features or fix bugs

Examples:

123 ADD Support for multi-region deployments
234 FIX Resolve cache issue on deployment
345 REFACTOR Move user authentication to middleware

Important Note on Enterprise Code Contributions

Please note that we do not accept contributions for parts of the codebase licensed under the Terrateam Enterprise License, as these features are critical to our business model and provide the foundation for how we fund ongoing development and support. However, we welcome contributions to the open-source portions of the project, which are licensed under the Mozilla Public License 2.0 (MPL-2.0). By focusing community efforts on the open-source side, we can keep improving Terrateam together while ensuring the sustainability of the project through our enterprise offerings.

Review Process

All pull requests will be reviewed by our team. While we welcome contributions, especially for bug fixes and new features, please understand that our codebase is written with specific styles. As such, your contribution may be rewritten to align with our standards and practices. This is not a reflection of the quality of your work, but rather a step to ensure consistency across the project.

If your pull request involves a significant feature, we may discuss potential modifications or alternative approaches during the review. We encourage you to engage in this process, as it helps us maintain the integrity and quality of Terrateam.

We appreciate your understanding and value your contributions to the project. Your efforts are integral to the ongoing improvement of Terrateam.

Code of Conduct

We are committed to providing a welcoming and inclusive environment for all contributors. Please read our Code of Conduct and ensure that your contributions adhere to these guidelines.

License

By contributing to Terrateam, you agree that your contributions will be licensed under the Mozilla Public License 2.0 (MPL-2.0).

Thank You!

Thank you for contributing to Terrateam! Your support and involvement are what make this project possible.