Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 2.17 KB

CONTRIBUTORS.md

File metadata and controls

41 lines (26 loc) · 2.17 KB
Raw

Contributing to ngx-forms-typed

Hi, and thanks for your interest!

There are:

  • ngx-forms-typed - /projects/forms
  • /src - an example app showcasing usage of the lib

Setup

We are using a couple of libraries to setup our process of contributing:

  • husky - will run a pre-commit step to verify that the commit message adheres to Angular standard commit
  • semantic-release takes care of release based on the commits - check out their great docs but in short
    • fix will create new patch version 1.0.5 -> 1.0.6
    • feat will create new minor version 1.0.6 -> 1.1.0
    • BREAKING CHANGE will create new major version 1.1.0 -> 2.0.0
  • we use the standard format based on Keep a Changelog
  • we utilize GitHub actions to build and release our libraries (see .github/workflows/release-forms-typed.yml, etc.)

Crafting a PR

All of the above means that when preparing your PR you'll have to:

  • adhere to the commit standard (and we have a pre-commit step that will fail your commit if you don't)
  • add a line to the project's Changelog.md (this is not automated)
  • add a test or two for your change
    • ngx-forms-typed - /projects/forms/src/lib/forms-typed.tests.ts

Recipies

Look into the following to make sense on the release process

Error example

'./assets/commit-error.png'

This is what an error looks like in the console and in the VS Code (on Windows). An acceptable message would be chore:fix typo