-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Contributing to venvstacks | ||
|
||
Thank you for your interest in contributing to `venvstacks`! There are many ways to | ||
contribute, and we appreciate all of them. | ||
|
||
While `venvstacks` is not a Python Packaging Authority project, it is nevertheless | ||
part of the Python packaging ecosystem, and hence likely to be discussed in | ||
PyPA-managed communication channels. All contributors are expected to abide by the | ||
[PyPA Code of Conduct][pypa-coc]. | ||
|
||
[pypa-coc]: https://www.pypa.io/en/latest/code-of-conduct/ | ||
|
||
## Before you start | ||
|
||
If you are planning to add a feature or fix a bug, | ||
please [open an issue](https://github.com/lmstudio-ai/venvstacks/issues) 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, | ||
so please check if there is an existing issue before filling a new one. | ||
|
||
For general `venvstacks` discussion (not specific to its use in LM Studio), there is a | ||
`#venvstacks` channel within the [PyPA Discord server](https://discord.com/invite/pypa). | ||
|
||
For questions specifically related to the Python environment stacks used in LM Studio, | ||
the team is available through the `#dev-chat` channel within the | ||
[LM Studio Discord server](https://discord.gg/pwQWNhmQTY). | ||
|
||
## Development Documentation | ||
|
||
Our [development documentation](https://venvstacks.github.io/development/) contains | ||
details on how to get started with contributing to `venvstacks`, | ||
and details of our development processes. |