Skip to content

Latest commit

 

History

History
40 lines (21 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

40 lines (21 loc) · 1.51 KB
Raw

Contributing to Create Elm App

Thank you for considering contributing to Create Elm App!

Would you like to get involved?

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Setting Up a Local Copy

  1. Fork the repo and clone with git clone [email protected]:%YOUR_USERNAME%/create-elm-app.git

  2. Run npm install in the root create-elm-app folder to install all dependencies.

  3. Run npm link in the root create-elm-app folder to install local module globally.

Running tests

You can run tests by running $npm run test.

If you run into failures while ugrading dependencies, running $npm run app:build will allow you to check the build faster.

NOTE: Functional tests may take a while to run because they interact with your system.

Submitting a Pull Request

When you have a local copy of the project up and running, create a new branch with a name, such as patch-1

git checkout -b patch-1

Create Elm App uses Commitizen and semantic-release for release automation.

Commit changes by running npm run cz

Follow the prompt and try to specify as much information as possible.