Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 4.1 KB
Raw

CONTRIBUTING.md

Introduction

Welcome to the Klotho project, and thank you for your interest in contributing! Klotho is an open-source tool that transforms plain code into cloud-native code. We appreciate all contributions from our community, whether you're new to open-source projects or an experienced contributor.

Code of Conduct

By participating in this project, you agree to abide by the Contributor Covenant v2.1. Please read the full text of the Code of Conduct to ensure a welcoming and inclusive environment for everyone involved in the project.

Getting Started

  1. Fork the Klotho repository on GitHub.
  2. Clone your fork to your local machine: git clone https://github.com/YOUR_USERNAME/klotho.git
  3. Set up your development environment by following the instructions provided in the README.md file.

How to Contribute

Reporting Issues

If you encounter any issues or have a feature request, please create a new issue on the Klotho GitHub repository. When reporting an issue, provide clear steps to reproduce the issue, any relevant error messages, and your expected outcome. For feature requests, please provide a clear description of the feature and its potential benefits to the project.

Signing the Contributor License Agreement (CLA)

For first-time contributors, we require you to sign the Contributor License Agreement (CLA) before we can accept your contributions. This agreement ensures that you're granting the project the right to use and distribute your contributions under the terms of the project's open-source license.

We use CLA Assistant to manage and track CLA signatures. When you submit your first pull request, a bot will automatically check if you have signed the CLA. If you haven't, you will receive a comment with a link to sign the CLA online.

Please follow these steps to sign the CLA:

  1. Click the link provided in the bot's comment on your pull request.
  2. Review the CLA document and ensure you understand the terms.
  3. Sign the CLA by providing your name, email address, and GitHub username.
  4. Once you've signed the CLA, the bot will update the status of your pull request, and the project maintainers can proceed with reviewing your contribution.

Note: You only need to sign the CLA once. After signing, your CLA signature will apply to all your future contributions to the project.

Bug Fixes and New Features

  1. Identify an issue to work on or create a new issue for the feature or bug fix you'd like to contribute.
  2. Create a new branch for your changes: git checkout -b feature/your-feature-name or git checkout -b fix/your-fix-name.
  3. Make your changes and commit them with a clear and descriptive commit message.
  4. Push your branch to your fork on GitHub: git push origin feature/your-feature-name or git push origin fix/your-fix-name.
  5. Create a pull request (PR) from your fork to the main Klotho repository.
    • Provide a clear and concise description of the changes in your PR.
    • Reference the issue number that your PR addresses (e.g., "Fixes #123").
  6. Wait for a project maintainer to review your PR. They may request changes or provide feedback before merging your changes.

Documentation Updates

If you notice any errors or outdated information in the documentation, please create an issue on the Klotho GitHub repository to report the problem. If you'd like to contribute a fix or update the documentation, follow the same steps as described above for bug fixes and new features.

Testing

Before submitting your changes, ensure that your code passes all tests. To run the tests, follow the instructions provided in the Developing section of the README.md file.

Community

Join the Klotho community on Discord to ask questions, share your experiences, and connect with other contributors.

Once again, thank you for your interest in contributing to the Klotho project. Your efforts help make Klotho a better tool for everyone in the community!