Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

61 lines (45 loc) · 2.42 KB
Raw

Contributing

Welcome, and thanks for your interest in contributing! Please take a moment to review the following:

Style Guide

Getting Started

Setup

  1. Fork the repo and clone to your machine.
  2. Create a new branch with your contribution.
  3. Install npm on your machine.
  4. In the repo, install dependencies via: 
    pnpm i
  5. Voilà, you're ready to go!

Scripts

  • pnpm build – production build
  • pnpm check – type checks
  • pnpm test – runs jest, watching for file changes

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features

  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)

  • refactor: any code related change that is not a fix nor a feature

  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies

  • test: all changes regarding tests (adding new tests or changing existing ones)

  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)

  • chore: all changes to the repository that do not fit into any of the above categories

    e.g. feat(components): add new prop to the avatar component

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

Releases

A trade-off with using a personal repo is that permissions are fairly locked-down. In the mean-time releases will be made manually by the project owner.