Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 3.62 KB
Raw

Contributing to Toolkit

Welcome to Toolkit! We appreciate your interest in contributing to this open-source library. By contributing, you can help improve the functionality, usability, and quality of the library for the entire community. This guide outlines the contribution process and provides guidelines for submitting bug reports, feature requests, and pull requests.

How to Contribute

Please remember te following:

  • Run sbt scalafmtAll before submitting a PR.
  • Run sbt gen-doc to update the documentation.

Bug Reports

If you encounter a bug or unexpected behavior while using Toolkit, please follow these steps to submit a bug report:

  1. Check Existing Issues: Before submitting a new bug report, please search the GitHub Issues to see if a similar issue has already been reported.

  2. Provide Details: When submitting a bug report, include relevant information such as a clear description of the problem, steps to reproduce the issue, and any error messages or logs encountered. If possible, provide a minimal, reproducible example that demonstrates the issue.

  3. Be Responsive: Be prepared to engage in the discussion around your bug report. Maintainers or contributors may need additional information or clarification to help address the issue.

Feature Requests

If you have an idea for a new feature or enhancement that you would like to see in Toolkit, please follow these steps to submit a feature request:

  1. Check Existing Requests: Before submitting a new feature request, please search the GitHub Issues to see if a similar request already exists. If it does, you can add your input and support to the existing discussion.

  2. Provide a Clear Description: When submitting a feature request, clearly describe the problem you are trying to solve or the improvement you would like to see. Explain how the proposed feature would benefit the library and provide any relevant examples or use cases.

  3. Be Open to Discussion: Feature requests often involve discussions with maintainers and contributors to refine and validate the proposal. Be open to feedback and willing to iterate on the idea.

Pull Requests

We welcome pull requests for bug fixes, new features, or improvements to Toolkit. To submit a pull request, please follow these guidelines:

  1. Fork the Repository: Start by forking the Toolkit repository to your GitHub account.

  2. Create a Branch: Create a new branch in your forked repository to work on your changes. Use a descriptive name that reflects the purpose of your changes.

  3. Make the Changes: Implement your changes, following the coding conventions and style used in the project. Include necessary tests and ensure that existing tests pass.

  4. Submit the Pull Request: Once your changes are ready, submit a pull request to the main repository. Provide a clear description of the changes, including any relevant context or motivations behind them.

  5. Engage in the Review Process: Be prepared to engage in the code review process. Address any feedback or requested changes promptly and effectively.

Code of Conduct

Please note that by participating in the Toolkit project, you are expected to adhere to the Code of Conduct. We encourage respectful and inclusive participation in our community.

Thank you for your interest in contributing to Toolkit. Your contributions are highly appreciated and help make the library even better for everyone!