Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.3 KB
Raw

Contributing to Cachier

Thank you for contributing to cachier 🎉 Any contributions to cachier are appreciated and encouraged.

Table of contents

  1. Code of Conduct
  2. How to contribute
    1. Creating issues
    2. Opening pull requests
  3. How to run locally
  4. Additional information

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct document. By participating, you are expected to uphold this code. Please report unacceptable behaviour to [email protected]

How to contribute

Creating issues

Before submitting issues, please have a quick look if there is an existing open issue here: Issues. If no related issue can be found, please open a new issue with labels.

Opening pull requests

Pull requests are more than welcome! Just make sure that to include a description of the problem and how you are attempting to fix the issue, or simply follow the Pull Request description template.

How to run locally

Here some steps to run cachier locally:

via yarn

$ cd cachier
$ yarn install
$ yarn test

via npm

$ cd cachier
$ npm install
$ npm run test

Im still working on this project. Commits will be coming!