Skip to content

Commit 60b74dc

Browse files
authored
Update CONTRIBUTING.md
1 parent 2044140 commit 60b74dc

File tree

1 file changed

+53
-5
lines changed

1 file changed

+53
-5
lines changed

CONTRIBUTING.md

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
1-
# Contributing
1+
# Contributing to Our Open Source Projects
22

3-
`lmstudio-python` is the Python SDK for LM Studio. It is an open-source project under the Apache 2.0 license. We welcome community contributions. There are many ways to help, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or contributing code which can be incorporated into the SDK itself.
3+
First off, thank you for considering contributing to our open source projects! 👾❤️
4+
5+
`lmstudio-python` is the Python SDK for LM Studio. It is an open-source project under the MIT license. We welcome community contributions.
6+
7+
There are many ways to help, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or contributing code which can be incorporated into the SDK itself.
48

59
Note: the SDK documentation is maintained in combination with the [`lmstudio.js`](https://github.com/lmstudio-ai/lmstudio.js)
610
in a dedicated [documentation repo](https://github.com/lmstudio-ai/docs).
711

8-
## Before you start
12+
## Communication
13+
14+
- **The best way to communicate with the team is to open an issue in this repository**
15+
- For bug reports, include steps to reproduce, expected behavior, and actual behavior
16+
- For feature requests, explain the use case and benefits clearly
17+
18+
## Before You Contribute
919

10-
If you are planning to add a feature or fix a bug, please open an issue first to discuss it. This is mainly to avoid duplicate work and to make sure that your contribution is in line with the project's goals. The LM Studio team is available to chat in the `#dev-chat` channel within the [LM Studio Discord server](https://discord.gg/pwQWNhmQTY).
20+
- **If you find an existing issue you'd like to work on, please comment on it first and tag the team**
21+
- This allows us to provide guidance and ensures your time is well spent
22+
- **We discourage drive-by feature PRs** without prior discussion - we want to make sure your efforts align with our roadmap and won't go to waste
1123

12-
## How to make code contributions
24+
## Development Workflow
1325

1426
_`lmstudio-python` requires Python 3.11 or later_
1527

@@ -23,6 +35,40 @@ _`lmstudio-python` requires Python 3.11 or later_
2335
Refer to [`README.md`](./README.md) and [`testing/README.md`](testing/README.md)for additional details
2436
on working with the `lmstudio-python` code and test suite.
2537

38+
## Creating Good Pull Requests
39+
40+
### Keep PRs Small and Focused
41+
42+
- Address one concern per PR
43+
- Smaller PRs are easier to review and more likely to be merged quickly
44+
45+
### Write Thoughtful PR Descriptions
46+
47+
- Clearly explain what the PR does and why
48+
- When applicable, show before/after states or screenshots
49+
- Include any relevant context for reviewers
50+
- Reference the issue(s) your PR addresses with GitHub keywords (Fixes #123, Resolves #456)
51+
52+
### Quality Expectations
53+
54+
- Follow existing code style and patterns
55+
- Include tests for new functionality
56+
- Ensure all tests pass
57+
- Update documentation as needed
58+
59+
## Code Review Process
60+
61+
- Maintainers will review your PR as soon as possible
62+
- We may request changes or clarification
63+
- Once approved, a maintainer will merge your contribution
64+
65+
## Contributor License Agreement (CLA)
66+
67+
- We require all contributors to sign a Contributor License Agreement (CLA)
68+
- For first-time contributors, a bot will automatically comment on your PR with instructions
69+
- You'll need to accept the CLA before we can merge your contribution
70+
- This is standard practice in open source and helps protect both contributors and the project
71+
2672
## Q&A
2773

2874
- **How does `lmstudio-python` communicate with LM Studio?**
@@ -42,3 +88,5 @@ If you have any other questions, feel free to join the [LM Studio Discord server
4288
## Is the LM Studio team hiring?
4389

4490
Yes, yes we are. Please see our careers page: https://lmstudio.ai/careers.
91+
92+
Thank you for your contributions!

0 commit comments

Comments
 (0)