Skip to content

Commit 20de2b4

Browse files
jablanCopilot
andauthored
docs: Further explain PR title naming (#828)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 081db68 commit 20de2b4

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,18 @@ This project relies on [conventional commits](https://www.conventionalcommits.or
1414

1515
These changelogs and version bumps are generated as a separate pull requests (one for each client library) and currently need to be merged manually.
1616

17+
### PR titles
18+
19+
PR titles are important, as they are used to generate changelogs and version bumps for the generated client libraries. The format is `change_type(affected_library): description #STRINGS-TICKET`.
20+
21+
The `change_type` is one of the following:
22+
* `feat`: A new feature. Also applies to extending the schema with new endpoints, properties, query parameters. For every schema change, a new version of every client library needs to be generated.
23+
* `fix`: A bug fix. Also applies to fixing the schema (e.g. fixing a typo in a property name).
24+
* `docs`: Documentation only changes. This includes changes to the OpenAPI spec (e.g. field descriptions), but not to the schema itself. This does not require a new version of the client libraries.
25+
* `build`: Changes that affect the build system or external dependencies (example: a change in github actions).
26+
27+
`affected_library` could be for example `PHP`, `Java`, `Go`, `Python`, `Ruby`, `CLI`, or `JS`, but most commonly it's `API`, in case of any schema changes.
28+
1729
### Example
1830

1931
You added an endpoint in Phrase Strings. In this project you do the following:
@@ -22,7 +34,7 @@ You added an endpoint in Phrase Strings. In this project you do the following:
2234
2. Add new endpoints to `/paths/` directory and reference it in `paths.yaml`
2335
3. `npm start` to re-build the clients
2436
4. `npm run docs` to generate the documentation (and verify it in action using `npm run watch`)
25-
5. Open a PR with an informative title (e.g. `feat(api): Add an API endpoint for cat pics`)
37+
5. Open a PR with an informative title (e.g. `feat(API): Add an API endpoint for cat pics`)
2638

2739
## Workflow
2840

0 commit comments

Comments
 (0)