Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 2.44 KB
Raw

Contributing Guidelines

Welcome!

Thank you for considering contributing to the KCommand project. Everyone is welcome to contribute, and we value every contribution.

Project Description

This project offers a flexible implementation of an event bus design pattern in Kotlin, with an emphasis on the integration of middleware. It supports diverse communication demands between any types of components and enables additional processing layers through middleware, enhancing the modularity and adaptability of your application.

How to Contribute

We use GitHub to manage issues and pull requests. To contribute, you can:

  • See the open issues on GitHub and pick an issue to work on
  • Suggest a new feature or improvement
  • Report a bug that you encountered when using this project

Before sending a pull request, please ensure that your code adheres to the standard formatting guides and passes all the tests.

Code Contributions

Here is a quick guide to doing code contributions:

  1. Fork the repo and create your branch off the main branch.
  2. If you've added code, please add unit tests, which adequately cover the code changes.
  3. Ensure the test suite passes before submitting a pull request
  4. After you've made your changes or additions, push to your forked repository and submit a pull request. In the pull request, describe what the changes do and mention any issues or bugs related to these changes.

Issues

Please follow these guidelines when creating GitHub issues:

  • Ensure the bug was not already reported.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample demonstrating the expected behavior that is not occurring.

Code of Conduct

This project follows a certain code of conduct to ensure an open and welcoming environment. By participating, you are expected to uphold this code. Please report any unacceptable behavior. For more details, please refer to our Code of Conduct.

License

By contributing to this project, you agree that your contributions will be licensed under its existing License. For more details, please refer to the License file we have in our repository.