Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .release-it.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@
"name": "conventionalcommits"
},
"infile": "CHANGELOG.md",
"strictSemVer": false,
"ignoreRecommendedBump": true
"strictSemVer": false
}
}
}
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,48 @@ Contributions are welcome. Feel free to open an issue or pull request for:
- Bug fixes or improvements
- Additional RSS news sources

## Commit Conventions

This project uses [Conventional Commits](https://www.conventionalcommits.org). Commit messages drive automatic version bumping and changelog generation.

### Format

```
<type>: <short description>
```

### Types

| Type | When to use | Version bump |
| ---------- | ----------------------------------------------- | ------------ |
| `feat` | New feature or capability | `minor` |
| `fix` | Bug fix | `patch` |
| `chore` | Maintenance, deps, config — nothing user-facing | none |
| `docs` | Documentation only | none |
| `refactor` | Code restructure, no behaviour change | none |
| `test` | Adding or updating tests | none |
| `ci` | CI/CD changes | none |

For a **breaking change**, add `!` after the type:

```
feat!: redesign navigation
```

This triggers a `major` version bump.

### Examples

```bash
feat: add RSS feed filter by category
fix: correct broken link in privacy tools list
chore: update dependencies
docs: improve getting started guide
refactor: extract fetch logic into utility function
ci: add lint step to CI workflow
feat!: remove legacy theme support
```

## Release Process (maintainers)

This project uses [release-it](https://github.com/release-it/release-it) for versioning, changelog generation, and GitHub Releases.
Expand Down
Loading