Skip to content

Commit

Permalink
Updating READ.me AND Contribuing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
robisson committed Feb 17, 2019
1 parent 48285e2 commit 421cf8a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 11 deletions.
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ We will is monitoring for pull requests. We will review your pull request and ei
4. If you've fixed a bug or added code that should be tested, add tests!
5. Ensure the test suite passes (`yarn test`).
6. Format your code with [prettier](https://github.com/prettier/prettier) (`yarn run prettier`).
7. Make sure your code lints (`yarn run lint`).
8. If you haven't already, agrree the CLA.
7. If you haven't already, agrree the CLA.

### Contributor License Agreement (CLA)

Expand All @@ -80,11 +79,10 @@ In order to accept your pull request, we need you to submit a CLA. You only need
After cloning Wipkanban, run `yarn install` to fetch its dependencies.
Then, you can run several commands:

* `yarn lint` checks the code style.
* `yarn test` runs the complete test suite backend api and frontend.
* `yarn run prettier` to format your code.
* `yarn run analyze` to generate [webpack bundle analyze](https://github.com/webpack-contrib/webpack-bundle-analyzer).
* `yarn run apidoc` to generate api documentation. To access go to `apidoc/index.html`.
* `yarn prettier` to format your code.
* `yarn analyze` to generate [webpack bundle analyze](https://github.com/webpack-contrib/webpack-bundle-analyzer).
* `yarn apidoc` to generate api documentation. To access go to `apidoc/index.html`.
* `yarn outdated` to verify if your dependences are updated.
* `yarn build` creates a `build` folder with all the code to production.

Expand All @@ -95,10 +93,7 @@ We still require that your pull request contains unit tests for any new function
### Style Guide

We use an automatic code formatter called [Prettier](https://prettier.io/).
Run `yarn run prettier` after making any changes to the code.

Then, our linter will catch most issues that may exist in your code.
You can check the status of your code styling by simply running `yarn run lint`.
Run `yarn prettier` after making any changes to the code.

However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at [Airbnb's Style Guide](https://github.com/airbnb/javascript) will guide you in the right direction.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WipKanban - **This project is not yet launched. The first version will be 2019-01-02**
# WipKanban - **This project is not yet launched. The first version will be 2019-04-01**
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png?v=103)](https://github.com/wipkanban/wipkanban/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/wipkanban/wipkanban.svg?branch=travisci)](https://travis-ci.org/wipkanban/wipkanban)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3fabcb66f2ee4c0f907ee76b48199da3)](https://www.codacy.com/app/WipKanban/wipkanban?utm_source=github.com&utm_medium=referral&utm_content=wipkanban/wipkanban&utm_campaign=Badge_Grade)
Expand Down

0 comments on commit 421cf8a

Please sign in to comment.