Skip to content

Latest commit

 

History

History
106 lines (73 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

106 lines (73 loc) · 1.81 KB
Raw

Contributing

Feel free to contribute to this project. Any sort of contributions are always welcome and are greatly appreciated.

Development

Visit the issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/soya-next.git
cd soya-next

Setup

To get you started real quick, run the following:

npm install

It will install external dependencies, build all packages, and link local dependencies.

Building

To build the module, run the following:

npm run build

To watch for code changes, run the following:

npm run watch

Running Tests

To test your code, run the following:

npm test

Code Style and Linting

This codebase follows Traveloka JavaScript Style Guide and is enforced using marlint.

To lint your code, run the following:

npm run lint

Examples

Setup

Open lerna.json and update it with the following:

{
  "lerna": "2.0.0",
  "npmClient": "yarn",
  "commands": {
    "bootstrap": {
-     "scope": [
+     "ignore": [
        "soya-next*"
      ]
    }
  },
  "packages": [
    "packages/*",
    "examples/*"
  ],
  "version": "0.2.11"
}

Then, run the following:

lerna bootstrap

It will install external dependencies and link local dependencies.

Building

To manually link the local repositories to any example app, run the following on each example directory:

npm link soya-next
npm link soya-next-scripts
npm link soya-next-server

To build and watch for code changes, run the following on each example directory:

npm start