diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..6350268 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,5 @@ +repos: + - repo: https://github.com/rbubley/mirrors-prettier + rev: v3.4.2 + hooks: + - id: prettier diff --git a/.prettierrc.yaml b/.prettierrc.yaml new file mode 100644 index 0000000..1deb191 --- /dev/null +++ b/.prettierrc.yaml @@ -0,0 +1 @@ +proseWrap: always diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 361b91c..3dd47c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,10 +96,19 @@ Please use branches and pull requests to contribute content. If you are not part ```shell git clone https://github.com/NLeSC/guide.git +cd guide git branch newbranch git checkout newbranch ``` +Please install [pre-commit](https://pre-commit.com/) and enable the pre-commit +hooks by running + +```shell +pre-commit install +``` +to automatically format your changes when committing. + Add your new awesome feature, fix bugs, make other changes. To preview changes locally, host the repo with a static file web server: