Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 1.67 KB

Contributing to Konsume

Thank you for your interest in contributing to Konsume! We value your contributions and want to make sure that contributing to this project is a positive and educational experience for everyone. Below are the guidelines for contributing to Konsume.

Reporting Issues

If you find a bug or have a suggestion for an improvement:

  1. Use the GitHub Issues page to check if the bug or improvement has already been reported.
  2. If not, open a new issue.
  3. Clearly describe the issue or suggestion, providing steps to reproduce if it's a bug.

Submitting Changes

If you want to contribute code or documentation:

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes, following branch naming conventions.
  3. Make your changes in your branch.
  4. Commit your changes, adhering to the commit message standarts.
  5. Push your changes to your fork.
  6. Submit a pull request to the dev branch of the konsume repository.

Pull Request Guidelines

When submitting a pull request:

  1. Ensure your code adheres to the project's coding standards.
  2. Include tests for new features or bug fixes.
  3. Ensure all tests pass.
  4. Update the documentation to reflect your changes if necessary.
  5. Describe your changes in detail in the pull request description.

Code Review Process

  • The project maintainers will review your pull request.
  • Maintain an open and respectful dialogue during the review process.
  • Address any suggested changes or improvements.
  • Once approved, a maintainer will merge your pull request.