Skip to content

Commit 0e77d58

Browse files
committed
update contributing guide
1 parent d507609 commit 0e77d58

File tree

1 file changed

+25
-35
lines changed

1 file changed

+25
-35
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -91,43 +91,33 @@ constructor(options?: ClientOptions) {
9191
3. Have the necessary permissions to publish packages
9292
4. Have a GitHub token with `repo` scope (for semantic-release)
9393

94-
### Publishing Steps
95-
1. Login to npm:
96-
```bash
97-
npm login
98-
```
94+
### Publishing Process
95+
The package uses automated releases through GitHub Actions. When changes are merged into the `main` branch:
96+
1. The CI pipeline runs tests and verifies the OpenAPI client generation
97+
2. If all checks pass, semantic-release automatically:
98+
- Determines the next version number based on PR titles
99+
- Updates package.json
100+
- Creates a git tag
101+
- Publishes to npm
102+
- Creates a GitHub release
99103

100-
2. Build the package:
101-
```bash
102-
npm run build
103-
```
104+
### Version Management
105+
The project uses semantic-release for automated version management. Version numbers are determined by PR titles:
106+
- `fix:` PRs trigger patch releases (1.0.0 → 1.0.1)
107+
- `feat:` PRs trigger minor releases (1.0.0 → 1.1.0)
108+
- PRs with `BREAKING CHANGE:` trigger major releases (1.0.0 → 2.0.0)
104109

105-
3. Make a release:
106-
```bash
107-
npm run release
108-
```
109-
This will:
110-
- Determine the next version number based on commit messages
111-
- Update package.json
112-
- Create a git tag
113-
- Publish to npm
114-
- Create a GitHub release
110+
Example PR titles:
111+
```
112+
fix: handle null values in response
113+
feat: add support for custom headers
114+
feat: add new API endpoint
115115
116-
### Version Management
117-
The project uses semantic-release for automated version management. Version numbers are determined by commit messages:
118-
- `fix:` commits trigger patch releases (1.0.0 → 1.0.1)
119-
- `feat:` commits trigger minor releases (1.0.0 → 1.1.0)
120-
- Commits with `BREAKING CHANGE:` trigger major releases (1.0.0 → 2.0.0)
121-
122-
Example commit messages:
123-
```bash
124-
git commit -m "fix: handle null values in response"
125-
git commit -m "feat: add support for custom headers"
126-
git commit -m "feat: add new API endpoint
127-
128-
BREAKING CHANGE: remove deprecated method"
116+
BREAKING CHANGE: remove deprecated method
129117
```
130118

119+
Note: Releases only happen when changes are merged into the `main` branch. Make sure your PR titles follow the conventional commit format as they determine the version bump.
120+
131121
## Code Style and Guidelines
132122

133123
### TypeScript
@@ -141,10 +131,10 @@ BREAKING CHANGE: remove deprecated method"
141131
1. Create a new branch for your feature/fix
142132
2. Make your changes
143133
3. Run tests (when available)
144-
4. Submit a pull request
134+
4. Submit a pull request with a descriptive title following the conventional commit format
145135

146-
### Commit Messages
147-
Follow conventional commits:
136+
### PR Titles
137+
Follow conventional commits format for PR titles:
148138
- `feat:` for new features
149139
- `fix:` for bug fixes
150140
- `docs:` for documentation changes

0 commit comments

Comments
 (0)