Skip to content

glossarist/glossarist-desktop

Repository files navigation

Glossarist desktop — cross-platform standardized terminology editor

Commitizen friendly Build/release

This application allows to collaboratively edit concept systems in Glossarist format.

Currently those are:

Contributing

PRs are welcome.

Committing

This repository is set up with AngularJS commit message convention. Pre-commit hook will invoke interactive prompt, powered by Commitizen, that will ask you for information and put together a commit message for you.

To follow the convention:

  • Only use git commit when making commits

  • Don’t use built-in IDE commit prompts, since they may bypass prepare-commit-msg hook

Pulling

  • It is recommended to use “rebase” behavior of pull (make sure to use fresh Git) by having this in your global .gitconfig:

    [pull]
        rebase = true
  • When pulling, Commitizen commit prompt may appear even if there is no merge commit to be made. You can dismiss it with Ctrl+C.

Pushing

There is a pre-push Git hook that compiles the app. This helps us catch compilation errors before code reaches CI.

Releasing

CI builds the application automatically, and publishes a release if it doesn’t yet exist for the version specified in package.json and Git version tag exists and is formatted appropriately.

After you have made and tested your changes:

  1. Edit package.json to increment version as appropriate, let’s say we are publishing 1.2.3.

  2. Tag and push the repository.

    Version tags are formatted as semantic version with “v” prepended, such as v1.2.3.

    $ git tag -s v1.2.3
    $ git push --follow-tags