alihan/datamodel-code-generator
1
0
Fork 0
mirror of https://github.com/koxudaxi/datamodel-code-generator.git synced 2024-03-18 14:54:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

chore: link to contributing guidelines from README.md (#1561)

Browse Source 
* chore: add CONTRIBUTING.md

* docs: add a link from README.md
This commit is contained in:
Tom Crasset
2023-09-21 18:26:23 +02:00
committed by GitHub
parent daa0ba6696
commit da4cbf589e
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -18,6 +18,7 @@ See [documentation](https://koxudaxi.github.io/datamodel-code-generator) for mor
## Sponsors
[![JetBrains](https://avatars.githubusercontent.com/u/60931315?s=200&v=4)](https://github.com/JetBrainsOfficial)
## Quick Installation
To install `datamodel-code-generator`:
@@ -456,6 +457,10 @@ This code generator creates [FastAPI](https://github.com/tiangolo/fastapi) app f
[https://pypi.org/project/datamodel-code-generator](https://pypi.org/project/datamodel-code-generator)
## Contributing
See `docs/development-contributing.md` for how to get started!
## License
datamodel-code-generator is released under the MIT License. http://www.opensource.org/licenses/mit-license

3
docs/development-contributing.md
View File

@@ -8,6 +8,7 @@ $ pip install -e datamodel-code-generator
```
# Contribute
We are waiting for your contributions to `datamodel-code-generator`.
## How to contribute
@@ -18,7 +19,7 @@ $ git clone git@github.com:<your username>/datamodel-code-generator.git
$ cd datamodel-code-generator
## 2. Install [poetry](https://github.com/python-poetry/poetry)
$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
$ curl -sSL https://install.python-poetry.org | python3 -
## 3. Install dependencies
$ poetry install