Skip to content

Commit e8fb5ef

Browse files
committed
docs: fix formatting, add link from CONTRIBUTING.md
1 parent 1491581 commit e8fb5ef

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,10 @@ docs: update testing guide with Vitest examples
149149
test: add fuzz tests for repo name validation
150150
```
151151

152+
### Release and Branching Process
153+
154+
To understand when your contribution will get merged upstream and published to NPM, see our [Releases guide](./docs/Releases.md).
155+
152156
## Testing
153157

154158
GitProxy has three test suites, each serving a different purpose.

docs/Releases.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ Both release notes and the release drafter workflow rely on [conventional commit
4343

4444
Release notes use PR titles directly. They should be written as user-facing changelog entries, in other words: in present tense, descriptive, and free of administrative references (meetings, etc.) or jargon.
4545

46-
**Good: ** fix: handle crashing on empty proxy config
47-
**Not good: ** fix: bug from last community call
46+
- **Good:** fix: handle crashing on empty proxy config
47+
- **Not good:** fix: bug from last community call
4848

4949
Keep in mind that maintainers may adjust the labels manually if appropriate.
5050

@@ -70,10 +70,11 @@ This workflow, detailed in [`npm.yml`](https://github.com/finos/git-proxy/blob/m
7070

7171
1. Builds the package
7272
2. Detects whether it's the latest version (e.g.: if the version you're publishing is `2.3`, and the latest on NPM `2.2`)
73-
a) If it's the latest version, it gets tagged as `'latest'` which is the default version that gets installed when calling `npx @finos/git-proxy`
74-
b) If it's a maintenance release on an older line, it gets tagged as `vX.Y` so users can pin it explicitly if needed
7573

76-
3) Publishes the package with the tag defined above
74+
- If it's the latest version, it gets tagged as `'latest'` which is the default version that gets installed when calling `npx @finos/git-proxy`
75+
- If it's a maintenance release on an older line, it gets tagged as `vX.Y` so users can pin it explicitly if needed
76+
77+
3. Publishes the package with the tag defined above
7778

7879
### Publishing a Patch Release
7980

0 commit comments

Comments
 (0)