Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (31 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.22 KB

Contributing to Book Builder

Here are some of the guidelines to follow if you intend to contribute!

Code of Conduct

Book Builder uses Contributor Covenant. Failure to adhere to these standards will result in removal of contributions from the project.

Installation

npm npm:

# Clone repo
$ git clone https://github.com/blackboardd/book-builder.git
$ cd book-builder

# Install dependencies
$ npm install

# Start dev server
$ npm start

yarn yarn:

# Clone repo
$ git clone https://github.com/blackboardd/book-builder.git
$ cd book-builder

# Install dependencies
$ yarn install

# Start dev server
$ yarn start

Coding style

Please follow the coding style of the project.

  • yarn prettier reformats the code.
  • yarn lint runs manually the linting rules.

License

By contributing your code to this repo, you agree to license your contribution under the MIT license.