wanjia9506
/
langchain4j
mirror of https://github.com/langchain4j/langchain4j.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added a draft for contribution guidelines

This commit is contained in:
deep-learning-dynamo 2023-10-20 16:21:33 +02:00
parent 9719d8233f
commit e0d6b9dfd9
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -315,6 +315,15 @@ Please [let us know](https://github.com/langchain4j/langchain4j/issues/new/choos
Please help us make this open-source library better by contributing.
Some guidelines:
1. Follow [Google's Best Practices for Java Libraries](https://jlbp.dev/).
2. Keep the code compatible with Java 8.
3. Avoid adding new dependencies as much as possible. If absolutely necessary, try to (re)use the same libraries which are already present.
4. Follow existing code styles present in the project.
5. Ensure to add Javadoc where necessary.
6. Provide unit and/or integration tests for your code.
7. Large features should be discussed with maintainers before implementation.
## Use cases
You might ask why would I need all of this?