From 8d25ef62ecf209f479257523ddccc800f361f89c Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Tue, 11 Jul 2023 09:42:36 +0200 Subject: [PATCH] docs: Contribution example explained --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6f9c08de..ffb4306c 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,16 @@ This project relies on [conventional commits](https://www.conventionalcommits.or These changelogs and version bumps are generated as a separate pull requests (one for each client library) and currently need to be merged manually. +### Example + +You added an endpoint in Phrase Strings. In this project you do the following: + +1. Add newly added schema (if any) to `/schemas/` directory +2. Add new endpoints to `/paths/` directory and reference it in `paths.yaml` +3. `npm start` to re-build the clients +4. `npm run docs` to generate the documentation (and verify it in action using `npm run watch`) +5. Open a PR with an informative title (e.g. `feat(api): Add an API endpoint for cat pics`) + ## Workflow The following repositories are generated upon pushing to this one: