Skip to content

Commit

Permalink
docs(#39): updated getting started & added commitizen usage to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KL13NT committed Feb 10, 2021
1 parent 8d11022 commit 005e044
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 19 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,7 @@ standard-version then by all means feel free to commit as you usually do after
running `npm run precommit`.
Note though that your commit messages will be checked by `husky` to make sure they're
compliant either way.

> Make sure to
> [sign](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification)
> your commits. This guarantees ownership of your contributions.
55 changes: 36 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,31 +38,48 @@ groundwork is almost done so... _maybe_. 🤷~~ Added link rendering!

## Getting Started

### Developing
Just start the development server using the `dev` command. Voila!
This project uses `electron-forge` under the hood, allowing us to develop,
build, and publish our Electron app with simple commands.

### Building
You can build from source using the `make` command. Requires NodeJS and NPM,
just in case.
We use [Commitizen](https://github.com/commitizen) to manage the contribution flow.

When committing we use `npm run commit` instead of `git commit`. This initiates
commitizen and starts its interactive cli to create commit messages that follow
the guidelines. The commit is then linted by
[commitlint](https://github.com/conventional-changelog/commitlint) to make sure
it follows the [Angular Commit Message
Format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format).
For the reasoning behind this see issue [#39](https://github.com/KL13NT/clippy/issues/39).

> If you're an advanced user you may use `git commit` directly as long as your
> commits follow the guidelines.
## Why Electron?
Why not? I'm a frontend developer and work with JavaScript all the time, so this
was the easiest option available to me!
> Make sure to [sign](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification) your commits. This guarantees ownership of your contributions.
## Why Preact?
I was lazy and made this in a couple iterations over a few hours, so I didn't
want to build the DOM logic all over again.
To developer or build locally you first need to install the dependencies. We use
*npm* for this.

## Why not React?
I may port the code to some other
project and don't wish to take the large size with me. Was a nice experiment as well.
```
npm install
```

### Developing

## What the hell is `htm`?
`htm` is a JSX alternative using standard tagged templates. It basically allows
you to write JSX-like code without babel!
In development, the electron-forge dev command is used to start the application
in development mode.

## 🧩 Feature Requests & 🐞 Bug Reports
Feel free to do either or both! Everyone's welcome!
```
npm run dev
```

### Building
You can build from source using the `make` command. Building for a target OS requires
that respective OS. You probably won't need to run this unless you're on the
core team.

```
npm run make
```

## ✋ Wish to Contribute?

Expand Down

0 comments on commit 005e044

Please sign in to comment.