Skip to content

Commit

Permalink
docs(README): add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
tillywoodfield committed May 15, 2024
1 parent 3f99f1d commit 63f22e1
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing

## How to contribute code

### Commit messages

This project uses [semantic-release](https://github.com/semantic-release/semantic-release) to automatically release when changes are merged to `main`.

In order for this to work, commit messages must use [Angular Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format), which in the simplest form looks like `<type>: <short summary>`. Below are some examples:

- `feat: added new component`
- `fix: fixed a bug`
- `docs: updated documentation`

If your change is a breaking change, this must be stated in the message, for example:

```
feat: updated some component
BREAKING CHANGE: removes the '.subcomponent' class.
```

### What is a breaking change?

A breaking change is any "incompatible API change". In the context of this design system, the API consists of CSS classes and SASS variables/functions/mixins etc. Any change which removes or renames a part of the API must be labelled a breaking change.
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ Start storybook:
npm start
```

## Project Structure

Sass code roughly follows [The 7-1 Pattern](https://sass-guidelin.es/#the-7-1-pattern).

Storybook stories should be placed alongside their respective component.

## Production build

Build CSS:
Expand Down

0 comments on commit 63f22e1

Please sign in to comment.