Skip to content

Latest commit

 

History

History
45 lines (20 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

45 lines (20 loc) · 1.55 KB

Contributing to PyLLM

Thank you for considering contributing to PyLLM

Ways to Contribute

  • Bug Reports: If you find a bug in the software, please check our issue tracker to see if it has already been reported. If it hasn't, submit a new issue with as much detail as possible, including steps to reproduce the bug and any error messages.

  • Feature Requests: Have an idea for a new feature or think something could be improved? Open a new issue and tag it as a feature request.

  • Code Contributions: Interested in adding a feature or fixing a bug? Read on to learn about our development process.

  • Documentation: Improve our documentation to make PyLLM more accessible to everyone.

Development Process

  • Fork the repo on GitHub.

  • Clone your fork locally on your machine.

  • Create a branch for your contribution. Use a clear branch name that describes the feature or fix.

  • Commit your changes. Keep your commits as small as possible and focused on a single aspect of improvement. Write meaningful commit messages.

  • Make sure to reformat your code using the black formatter

Pull Request Guidelines

  • Ensure your PR title clearly describes the change.

  • Include a description of what your PR addresses and the motivations behind it.

  • Link to any relevant issues your PR addresses.

  • Keep your PRs focused on a single issue. If your PR addresses multiple issues or includes multiple features, consider breaking it up into smaller PRs.

Getting Help

If you need help with anything related to contribution, feel free to ask questions on the issues page.