Contributing

Contributing

Get Started

I. Setup the project

git clone https://github.com/Taglyatelle/taglyatelle.git
source .venv/bin/activate
just install-prod

II. Create a branch (from the master branch)

git checkout -b branch_name

III. Making changes, and check your work:

just preco
just unittest

IV. Commit

git add .
git commit -m "your message"

V. Push your branch

git push origin branch_name

Create a pull request

I. Test the webhook events

# Start the smee proxy (in one terminal)
export $(grep -v '^#' .env | xargs)
npx smee -u ${WEBHOOK_PROXY_URL} -t http://localhost:8000/taglyatelle/webhooks

# Method n°1: Start the taglyatelle API (in another terminal)
just docker-build
just docker-run

## Method n°2: run the API (not recommanded)
uvicorn taglyatelle.exposition.taglyatelle_api:app --host 0.0.0.0 --port 8000

Then, trigger a webhook and check the app's response and results. Don't forget to include your own ENV variables in .env.

II. Run just commands

just preco
just unittest
just bump2version XXXXX (choices : major / minor / patch)

III. Create a PR from your branch to master

IV. Review the PR and merge it.