Skip to content

Commit db276bd

Browse files
committed
link to separate contribute readme
1 parent 61a2ac0 commit db276bd

File tree

2 files changed

+28
-35
lines changed

2 files changed

+28
-35
lines changed

CONTRIBUTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
We welcome contributions from developers of all levels. If you find anything amiss with the notebooks or dependencies, please feel free to create a pull request.
2+
3+
If you want to change the conda dependency specification (the yaml file), you can test it like this:
4+
```bash
5+
conda env create --file langchain_ai.yaml --force
6+
```
7+
8+
You can update the pip requirements like this:
9+
```bash
10+
pip freeze > requirements.txt
11+
```
12+
13+
Please make sure that you keep these two ways of maintaining dependencies in sync.
14+
15+
Then make sure, you test the notebooks in the new environment to see that they run.
16+
17+
# Code validation
18+
We've included a `Makefile` that includes instructions for validation with flake8, mypy, and other tools. I have run mypy like this:
19+
```bash
20+
make typecheck
21+
```
22+
23+
To run the code validation in ruff, please run
24+
```bash
25+
ruff check .
26+
```
27+

README.md

+1-35
Original file line numberDiff line numberDiff line change
@@ -251,42 +251,8 @@ You can find more details about API credentials and setup in chapter 3 of the bo
251251

252252
## 👋 Contribute
253253

254-
We welcome contributions from developers of all levels. If you find anything amiss with the notebooks or dependencies, please feel free to create a pull request.
254+
We welcome contributions from developers of all levels. If you'd like to contribute, please check our [contributing guidelines](./CONTRIBUTING.md) and help make this repository and the book more accessible.
255255

256-
If you want to change the conda dependency specification (the yaml file), you can test it like this:
257-
```bash
258-
conda env create --file langchain_ai.yaml --force
259-
```
260-
261-
You can update the pip requirements like this:
262-
```bash
263-
pip freeze > requirements.txt
264-
```
265-
266-
Please make sure that you keep these two ways of maintaining dependencies in sync.
267-
268-
Then make sure, you test the notebooks in the new environment to see that they run.
269-
270-
---
271-
[![Star History Chart](https://api.star-history.com/svg?repos=benman1/generative_ai_with_langchain&type=Timeline)](https://star-history.com/#benman1/generative_ai_with_langchain&Date)
272-
273-
274-
## ❤️ Contributors
275-
276-
[![repo contributors](https://contrib.rocks/image?repo=benman1/generative_ai_with_langchain)](https://github.com/benman1/generative_ai_with_langchain/graphs/contributors)
277-
278-
### Code validation
279-
I've included a `Makefile` that includes instructions for validation with flake8, mypy, and other tools. I have run mypy like this:
280-
```bash
281-
make typecheck
282-
```
283-
284-
To run the code validation in ruff, please run
285-
```bash
286-
ruff check .
287-
```
288-
</details>
289-
290256

291257
<details>
292258
<summary><h2>Get to know the authors</h2></summary>

0 commit comments

Comments
 (0)