Thanks for being here! Fern gives a lot of importance to being a community project, and we rely on your help as much as you rely on ours. If you have any feedback on what we could improve, please open an issue to discuss it!
All contributions start with an issue. Even if you have a good idea of what the problem is and what the solution looks like, please open an issue. This will give us an opportunity to align on the problem and solution, and to deconflict in the case that somebody else is already working on it.
Review our documentation! We appreciate any help we can get that makes our documentation more digestible.
Talk about Fern in your local meetups! Even our users aren't always aware of some of our features. Learn, then share your knowledge with your own circles.
Write code! We've got lots of open issues - feel free to volunteer for one by commenting on the issue.
Our repo is that uses poetry for environment setup and dependency management.
To get started:
Step 1: Fork this repo
Fork by clicking here.
Step 2: Clone your fork
git clone <your fork>
cd fern-python
Step 3: Install Poetry
See here for installation instructions.
Step 4: Install project and open in VSCode
poetry shell
poetry install
code .
To compile using mypy, run poetry run mypy.
We use pre-commit to run formatters and linters. These are run automatically on changed files when you commit.
These are managed by .pre-commit-config.yaml. You can run the steps on all files by running:
poetry run pre-commit run --all-files
To run the SDK tests:
poetry run pytest tests/sdk/test_sdk.py
To run the FastAPI tests:
poetry run pytest tests/fastapi/test_fastapi.py