Skip to content

Commit 82ca31a

Browse files
dbrattliclaude
andcommitted
docs: Add commit convention section to README
Document the conventional commits requirement and release-please workflow for contributors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a7b6a33 commit 82ca31a

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To use the `Fable.Python` library in your Fable project:
4444
```fs
4545
open Fable.Python.Json
4646
47-
let object = {| A=10; B=20 |}
47+
let object = {| A=10n; B=20n |}
4848
let result = json.dumps object
4949
```
5050

@@ -121,11 +121,35 @@ This project uses [just](https://github.com/casey/just) as a command runner.
121121
## Contributing
122122

123123
This project is community driven. If the type binding you are looking
124-
for is currently missing, then you need to add them to the relavant
124+
for is currently missing, then you need to add them to the relevant
125125
files (or add new ones). Open a
126126
[PR](https://github.com/dbrattli/Fable.Python/pull/3/files) to get them
127127
included.
128128

129+
### Commit Convention
130+
131+
This project uses [Conventional Commits](https://www.conventionalcommits.org/)
132+
and [release-please](https://github.com/googleapis/release-please) for automated
133+
releases. PR titles must follow the format:
134+
135+
```
136+
type: description
137+
```
138+
139+
Where `type` is one of:
140+
- `feat` - New features (bumps minor version)
141+
- `fix` - Bug fixes (bumps patch version)
142+
- `docs` - Documentation changes
143+
- `chore` - Maintenance tasks
144+
- `refactor` - Code refactoring
145+
- `test` - Adding or updating tests
146+
- `ci` - CI/CD changes
147+
- `build` - Build system changes
148+
- `perf` - Performance improvements
149+
150+
Breaking changes should include `!` after the type (e.g., `feat!: breaking change`)
151+
and will bump the major version.
152+
129153
The `src/stdlib` directory contains type bindings for modules in the
130154
Python 3 standard library. We also accept type bindings for 3rd party
131155
libraries as long as:

0 commit comments

Comments
 (0)