Skip to content
This repository was archived by the owner on Jul 16, 2025. It is now read-only.

Commit 56673df

Browse files
authored
docs: add contributing file (#238)
1 parent ab9da42 commit 56673df

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
You want to contribute to this project? Great! We are happy to welcome you to the repository. Please read the following
4+
guidelines to get started. It will help to make the contribution process easy and effective for everyone involved.
5+
6+
## Disclaimer
7+
8+
Before you start contributing, please be aware that this project is not commercial and is maintained by volunteers in
9+
their free time to share code among themselves and with the community. We are happy to invest our time in this project
10+
and to share it with you. However, we cannot guarantee that we will be able to respond to your requests in a timely
11+
manner or that we will be able to implement your suggestions.
12+
13+
## Questions and Support
14+
15+
If you have any questions or problems while using LLM Chain, please check the [README](README.md) file and also the
16+
[examples](examples) folder. If you can't find the answer there, feel free to open an
17+
[issue](https://github.com/php-llm/llm-chain/issues).
18+
19+
## Bug Reports
20+
21+
If you open an issue to report a bug, please make sure to provide enough information to reproduce the bug. Ideally even
22+
provide a code snippet that reproduces the bug. This will help us to fix the bug faster.
23+
24+
## Feature Ideas
25+
26+
Of course, we are happy to get your ideas for new features. And for sure, we are happy if you want to implement them.
27+
However, to make sure that you are not wasting your time, please open an issue first to discuss your idea in case it is
28+
a larger change.
29+
30+
## Pull Requests
31+
32+
When you end up implementing a new feature or fixing a bug, please open a pull request. The pipeline will help you to
33+
check if your code is following the coding standards and if all tests are passing. To execute the tools locally, you
34+
can use the following commands:
35+
36+
```bash
37+
make qa
38+
make qa-lowest
39+
```
40+
41+
Commit messages should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -671,7 +671,8 @@ final class MyProcessor implements OutputProcessor, ChainAwareProcessor
671671
672672
## Contributions
673673
674-
Contributions are always welcome, so feel free to join the development of this library.
674+
Contributions are always welcome, so feel free to join the development of this library. To get started, please read the
675+
[contribution guidelines](CONTRIBUTING.md).
675676
676677
### Current Contributors
677678

0 commit comments

Comments
 (0)