Skip to content

Commit

Permalink
docs: semantic versioning instructions for React components
Browse files Browse the repository at this point in the history
  • Loading branch information
Robbert committed Feb 21, 2025
1 parent bb431cc commit d35225b
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions packages/component-library-react/SEMVER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Semantic versioning

## Changeset

Algemene richtlijnen:

- Changesets zijn in het Engels.
- Gebruik volledige zinnen, met juist hoofdlettergebruiken en punctuatie.
- Plaats ongerelateerde changes in losse changeset bestanden.
- Noem in de lijst met packages ook de dependencies waar de wijziging ook impact heeft.

### Component toevoegen

Een component toevoegen is een nieuwe feature, daarom een **minor** change.

### Component verwijderen

Een component verwijderen maakt projecten kapot die een dependency hebben op de component, daarom een **major** change.

### Component hernoemen

Een component hernoemen maakt projecten kapot die een dependency hebben op de huidige naam van de component, daarom een **major** change.

#### Backwards-compatibility bij hernoemen

Als je volledig backwards compatible bent, en alle APIs blijven werken voor bestaande gebruikers, dan mag het een **minor** change zijn.

Alle API's betekent ondere andere:

- De exports in de component file
- `export type`
- `export interface`
- `export const`
- De exports in de `index.ts` "barrel files": `export { MyComponentName } from './MyComponentName';`
- De filenames van componenten: `@example/component-library/MyComponentName` en `@example/component-library/NewComponentName` werken allebei

## Property of method toevoegen

Een component toevoegen is een nieuwe feature, daarom een **minor** change.

## File uit de `exports` verwijderen

Een bestand uit de build verwijderen maakt projecten kapot die dat bestand importeren, daarom een **major** change.

0 comments on commit d35225b

Please sign in to comment.