Skip to main content

Contributing

To provide backwards compatibility guarantees, the core of the KP library should not change. This means that any changes to the core API or the behavior of the core should be avoided.

However, we do accept pull requests that involve adding new middlewares or making non-breaking changes to existing middlewares. These changes can help evolve the KP library and provide new features and functionality without affecting the core.

Issue Reports​

If you encounter any problems or bugs while using the KP library, please open an issue on the GitHub repository.

To ensure that your issue is properly addressed, please include the following information in your report:

  • A clear and concise description of the problem
  • Steps to reproduce the problem
  • The expected behavior
  • The actual behavior
  • Any relevant logs, error messages, or screenshots

Pull Requests​

We welcome contributions to the KP library in the form of pull requests.

Before submitting a pull request, please make sure that your changes meet the following guidelines:

  • Your code should be well-documented and adhere to the project's style guidelines
  • Your code should be tested and all tests should pass
  • Your changes should not break existing functionality or introduce new bugs
  • Your changes should be focused and narrowly-scoped, rather than attempting to solve a large number of unrelated issues

To submit a pull request, follow these steps:

  • Fork the KP repository
  • Create a new branch for your changes
  • Make your changes and commit them to your branch
  • Push your branch to your fork
  • Open a pull request on the KP repository, describing your changes and why they are necessary

We will review your pull request and provide feedback. If your changes are accepted, we will merge them into the main branch of the repository.

Additional Notes​

Keep in mind that the core of the KP library should not change to ensure backwards compatibility. If you have an idea for a new feature or functionality that requires changes to the core, please open an issue to discuss it before submitting a pull request.

We highly encourage contributions in the form of new middlewares or non-breaking changes to existing middlewares. These types of changes can help evolve the KP library and provide new features and functionality without affecting the core.

Thank you for considering contributing to the KP library! We appreciate your efforts and look forward to reviewing your pull requests.