Skip to main content

Contributing

Thank you for considering contributing to Kblocks! We welcome contributions from the community and are excited to see what you can bring to the project. Please take a moment to review this document to make the contribution process easy and effective for everyone involved.

How Can I Contribute?​

Reporting Bugs​

If you find a bug, please report it by opening an issue on our GitHub Issues page. Please include:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant logs or screenshots.

Suggesting Enhancements​

We welcome suggestions for new features or improvements. To suggest an enhancement, please open an issue on our GitHub Issues page and include:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement.
  • Any relevant examples or mockups.

Pull Requests​

If you would like to contribute code, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeatureName).
  3. Make your changes.
  4. Test your changes.
  5. Commit your changes (git commit -m 'Add some feature').
  6. Push to the branch (git push origin feature/YourFeatureName).
  7. Open a pull request.

Please ensure your pull request adheres to the following guidelines:

  • The pull request should include a clear description of the changes.
  • The code should be well-documented and follow the project's coding style.
  • The pull request should be focused on a single change or feature.

Code of Conduct​

We follow the CNCF Code of Conduct. By participating in this project, you agree to abide by its terms. Please report any unacceptable behavior to the project maintainers.

Getting Help​

If you have any questions or need help, feel free to reach out by opening an issue or contacting the maintainers.

Thank you for your interest in contributing to Kblocks!