Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 2.16 KB
Raw

Contributing to lprs

Thank you for your interest in contributing to lprs! We welcome contributions from the community to help improve the project.

Getting Started

To get started with contributing to lprs, please follow these steps:

  1. Fork the lprs repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes: git checkout -b my-branch-name.
  4. Make your desired changes to the codebase.
  5. Test your changes to ensure they work as expected.
  6. Run just ci to run the continuous integration.
  7. Commit your changes: git commit -m "Add my changes".
  8. Push your changes to your forked repository: git push origin my-branch-name.
  9. Open a pull request from your forked repository to the main lprs repository.

Code Style

Please follow the existing code style and conventions used in the lprs project. This includes:

  • Using Rust's official formatting tool, rustfmt, to format your code.
  • Writing clear and concise code with meaningful variable and function names.
  • Adding comments to explain complex logic or algorithms.

Reporting Issues

If you encounter any issues or bugs while using lprs, please open a new issue on the GitHub repository. When reporting an issue, please provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.

Feature Requests

If you have a feature request or an idea for improving lprs, we encourage you to open a new issue on the GitHub repository. Please describe the feature or improvement in detail and provide any relevant context or examples.

Code Review

All contributions to lprs will go through a code review process. This ensures that the code meets the project's standards and maintains its quality. Please be open to feedback and suggestions from the project maintainers during the code review process.

License

By contributing to lprs, you agree that your contributions will be licensed under the project's LICENSE file. This means that you are granting lprs the right to use, modify, and distribute your contributions under the terms of the license. wich is GPL-3.0 License.

Happy contributing!