Skip to content

Commit

Permalink
refactor: use new Travis CI url, update docs and clean up a little
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinHelmut committed Dec 26, 2020
1 parent 4ac4fd4 commit 14afef4
Show file tree
Hide file tree
Showing 9 changed files with 777 additions and 1,377 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ lib/
node_modules/
compiled_tests/
CHANGELOG.md
pnpm-lock.yaml
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
language: node_js
node_js:
- "12"
- "14"
before_install: curl -L https://unpkg.com/@pnpm/self-installer | node
install: pnpm install
Expand Down
18 changes: 11 additions & 7 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,13 +116,17 @@ the community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla coc].

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
[https://www.contributor-covenant.org/faq][faq]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[mozilla coc]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

You want do contribute to this repo? Nice! And of course: **you are the best!** Here is a guide on how to work with it and what to expect.
You want to contribute to this repo? Nice! **You are the best!** Here is a guide on how to work with it and what to expect.

## Contents

Expand Down Expand Up @@ -65,7 +65,7 @@ pnpm run format

## Build the library

If you want to build the project run
To build the project run:

```shell script
pnpm run build
Expand All @@ -75,7 +75,7 @@ to generate a minified version of the library under `lib/`.

## View local library documentation

You can serve the documentation locally or via network with by running:
You can serve the documentation locally or via your local network by running:

```shell script
pnpm run docs
Expand All @@ -85,11 +85,11 @@ This will use [JSDoc][jsdoc] to generate the documentation.

## Commit changes

**This repo is is Commitizen-friendly!** (read more in the [official commitizen documentation][czcli])
**This repo is Commitizen-friendly!** (read more in the [official commitizen documentation][czcli])

Checkout a new branch, there is no naming convention for branches, only for commits. Add your changes and run `pnpx git-cz` (or `pnpm run commit`) to start the commitizen cli to create a proper commit message.

Push the changes and your feature branch and create a "Pull Request" on GitHub.
Push the changes with your feature branch and create a "Pull Request" on GitHub.

## Recommended workflow for release

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,10 +383,10 @@ Big thanks as well to Alex Ciminian for raising the issue with non ASCII charact

[npmurl]: https://www.npmjs.com/package/number-generator
[npmimg]: https://img.shields.io/npm/v/number-generator.svg
[travisimg]: https://travis-ci.org/MartinHelmut/number-generator.svg?branch=master
[travisorg]: https://travis-ci.org/MartinHelmut/number-generator
[covimg]: https://coveralls.io/repos/github/MartinHelmut/number-generator/badge.svg?branch=master
[covurl]: https://coveralls.io/github/MartinHelmut/number-generator?branch=master
[travisimg]: https://travis-ci.com/MartinHelmut/number-generator.svg?branch=main
[travisorg]: https://travis-ci.com/MartinHelmut/number-generator
[covimg]: https://coveralls.io/repos/github/MartinHelmut/number-generator/badge.svg?branch=main
[covurl]: https://coveralls.io/github/MartinHelmut/number-generator?branch=main
[czimg]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[czcli]: http://commitizen.github.io/cz-cli/
[stdimg]: https://img.shields.io/badge/release-standard%20version-brightgreen.svg
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
"ci": "pnpm run test:prod && pnpm test",
"commit": "git-cz",
"coverage": "nyc report --reporter=text-lcov | coveralls",
"format": "prettier --write \"**/*.{js,ts,md,json,yml}\"",
"format:check": "prettier --list-different \"**/*.{js,ts,md,json,yml}\"",
"format": "prettier --write .",
"format:check": "prettier --list-different .",
"lint": "eslint --ignore-path .prettierignore ./",
"prerelease": "pnpm run ci",
"release": "standard-version -a",
Expand Down Expand Up @@ -124,6 +124,7 @@
"@babel/core": "7.12.10",
"@babel/preset-env": "7.12.11",
"@babel/register": "7.12.10",
"@rollup/plugin-babel": "^5.2.2",
"@rollup/plugin-node-resolve": "11.0.1",
"@rollup/plugin-replace": "2.3.4",
"@types/chai": "4.2.14",
Expand All @@ -144,7 +145,6 @@
"nyc": "15.1.0",
"prettier": "2.2.1",
"rollup": "2.35.1",
"rollup-plugin-babel": "4.4.0",
"rollup-plugin-clear": "2.0.7",
"rollup-plugin-copy": "3.3.0",
"rollup-plugin-external-globals": "0.6.1",
Expand Down
Loading

0 comments on commit 14afef4

Please sign in to comment.