Skip to main content

Contribute to llm-d

NOTE: the definitive version of these guidelines may always be found in the GitHub project at https://github.com/llm-d/llm-d/blob/dev/PROJECT.md

Contributing Guidelines

Thank you for your interest in contributing to llm-d. Community involvement is highly valued and crucial for the project's growth and success. The llm-d project accepts contributions via GitHub pull requests. This outlines the process to help get your contribution accepted.

To ensure a clear direction and cohesive vision for the project, the project leads have the final decision on all contributions. However, these guidelines outline how you can contribute effectively to llm-d.

How You Can Contribute​

There are several ways you can contribute to llm-d:

  • Reporting Issues: Help us identify and fix bugs by reporting them clearly and concisely.
  • Suggesting Features: Share your ideas for new features or improvements.
  • Improving Documentation: Help make the project more accessible by enhancing the documentation.
  • Submitting Code Contributions (with consideration): While the project leads maintain final say, code contributions that align with the project's vision are always welcome.

Reporting Issues​

Before submitting a new issue, please:

  • Check Existing Issues: Search the issue tracker to see if a similar issue has already been reported.
  • Be Clear and Concise: Provide a descriptive title and detailed steps to reproduce the issue. Include your operating system, relevant software versions, and any error messages.
  • Provide Context: Explain the expected behavior and what you observed instead.

Suggesting Features​

We welcome your ideas for improving llm-d! When suggesting a feature:

  • Explain the Use Case: Describe the problem the feature solves or the benefit it provides.
  • Provide Details: Outline how the feature would work, if possible.
  • Be Open to Discussion: Feature requests may be discussed and refined before a decision is made. The project leads will ultimately decide on the inclusion of new features based on the project's overall direction.

Improving Documentation​

Good documentation is essential for any project. You can contribute by:

  • Fixing Typos and Errors: Correcting any mistakes you find in the documentation.
  • Clarifying Explanations: Making existing documentation easier to understand.
  • Adding Missing Information: Documenting new features or expanding on existing ones.
  • Providing Examples: Creating clear and helpful usage examples.

Pull requests for documentation improvements are welcome.

Submitting Code Contributions​

The process for accepting code contributions is as follows:

  1. Discuss First (Recommended): For significant changes or new features, it's highly recommended to open an issue first to discuss in the community. This helps ensure your effort aligns with the project's goals and avoids potential rework.
  2. Fork the Repository: Create your own fork of the relevant llm-d repository.
  3. Create a Branch: Make your changes in a dedicated branch within your fork.
  4. Follow Coding Standards: Adhere to any existing coding style or conventions used in the project.
  5. Write Tests (if applicable): If your contribution includes code changes, please include relevant tests.
  6. Submit a Pull Request (PR): Once you're satisfied with your changes, submit a pull request to the main repository. Clearly describe the changes you've made and why.

Code Review Process​

All pull requests will be reviewed by the lead core Maintainer. Feedback will be provided, and you may be asked to make revisions. The project leads will ultimately decide whether to merge the pull request based on its alignment with the project's vision, code quality, and overall impact.

Community and Communication​

  • Developer Slack: Join our developer Slack workspace at [ llm-d.slack.com ] to connect with the core maintainers and other contributors, ask questions, and participate in discussions.

  • **Weekly Meetings:**Project updates, ongoing work discussions, and Q&A will be covered in our weekly project meeting. Details regarding the day, time, and meeting link will be shared soon!

  • Social Media: Follow us on social media for the latest news, announcements, and updates:

  • X: https://x.com/_llm_d_

  • LinkedIn: https://linkedin.com/company/llm-d

  • Reddit: https://www.reddit.com/r/llm_d/

License​

By contributing to llm-d, you agree that your contributions will be licensed under the Apache 2.0 License.

Code of Conduct​

Please note that we expect all contributors to adhere to a respectful and professional code of conduct. Detailed documentation can be found here https://github.com/llm-d/llm-d/blob/dev/CODE_OF_CONDUCT.md

Thank you again for your interest in llm-d! Your contributions, in any form, are valuable.