Skip to content

Commit

Permalink
Add more guidance in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tchoutri committed Jun 22, 2022
1 parent 59540bd commit 34dadc4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ but we need you to read this document when you open your PR or your issue:

We need you to read and acknowledge our [Code of Conduct][CoC] document.

The following Haskell command-line tools will have to be installed:

* `postgresql-migration`: The tool used to perform schema migrations
* `fourmolu`: The tool to style the code base
* `hlint` & `apply-refact`: The tools to enforce certain patterns in the code base ("lint")
* `cabal-fmt` and `nixfmt`: the tools to style the cabal and nix files
* `ghcid`: The tool to automatically reload the Haskell code base upon source changes

```bash
$ cabal install -j postgresql-migration fourmolu hlint apply-refact cabal-fmt nixfmt ghcid
```

* `yarn`: The tool that handles the JavaScript code bases
* `esbuild`: The tool that handles asset bundling

### Pull Requests

You need to
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ tools will still be accessible.

### Flora server

Configuration is handled through environment variables. They are all prefixed by `FLORA_` to avoid conflict, and the
The configuration is handled through environment variables. They are all prefixed by `FLORA_` to avoid conflict, and the
server will tell you which ones are missing.

To start in the best of conditions, create a file called `environment.local.sh` with the following content:
Expand Down Expand Up @@ -88,7 +88,7 @@ you can also use `db-create` and `db-drop` to create and delete the database in
### Docker Workflow

A docker-based workflow is provided. The idea is to develop from within a container that brings with it all dependencies,
and communicates with another container for the Postgres database.
and communicates with another container for the PostgreSQL database.

```bash
# You need to build the container first. It's gonna take around 13 minutes the first time you build
Expand Down

0 comments on commit 34dadc4

Please sign in to comment.