Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mahdi/project_updates #337

Merged
merged 7 commits into from
Sep 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 38 additions & 4 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,11 @@
# kelly-binary
# Mahboobeh-binary
# mahdipourziaei-binary
# mamali-fs
# morteza-binary
# mustofa-binary
# nazanin-binary
# negarn
# oskar-binary
# reza-fs
# sam-binary
# zaki-binary

Expand Down Expand Up @@ -74,6 +73,24 @@
# - sam-binary


# ===========================================================
# binary-com/deriv-core
# ===========================================================
# Used for approving all relevant changes to Core
#
# - aaron-binary
# - mahdipourziaei-binary


# ===========================================================
# binary-com/deriv-shared
# ===========================================================
# Used for approving all relevant changes to Core
#
# - Mahboobeh-binary
# - reza-fs


# ===========================================================
# binary-com/deriv-trader
# ===========================================================
Expand All @@ -82,12 +99,11 @@
# - brandon-binary
# - kelly-binary
# - mahdipourziaei-binary
# - mamali-fs
# - morteza-binary
# - mustofa-binary
# - nazanin-binary
# - negarn
# - oskar-binary
# - reza-fs
# - zaki-binary


Expand Down Expand Up @@ -123,6 +139,24 @@




# ================================================
# deriv-app/core
# ================================================

/packages/core/** @binary-com/deriv-core



# ================================================
# deriv-app/shared
# ================================================

/packages/shared/** @binary-com/deriv-shared
/packages/components/** @binary-com/deriv-shared



# ================================================
# deriv-app/trader
# ================================================
Expand Down
5 changes: 5 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Trader: packages/trader/**/*
Bot: packages/bot/**/*
Core: packages/core/**/*
Components: packages/components/**/*
Shared: packages/shared/**/*
14 changes: 14 additions & 0 deletions .github/workflows/label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Labeler
on:
schedule:
- cron: '0 3,8 */1 * *'

jobs:
label:

runs-on: ubuntu-latest

steps:
- uses: actions/labeler@v2
with:
repo-token: '${{ secrets.GITHUB_TOKEN }}'
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
Deriv App
============

This repository contains the various platforms of Deriv.

## Installation
- [Installation](#installation)
- [Working With This Repo](#working-with-this-repo)
- [Usage](#usage)
- [How to Clean Packages](#how-to-clean-packages)
- [Examples](#examples)
- [PR Guidelines](#pr-guidelines)
- [FAQ](#faq)

[comment]: <> (TODO: Refactor Clean Project to be under usage)

## Installation
In order to work on your own version of the Deriv Javascript and CSS, please **fork this project**.

You will need to perform the following on your development machine:
Expand All @@ -16,9 +24,7 @@ You will need to perform the following on your development machine:
[comment]: <> (1. Run `npm run bootstrap {package name}`. Replace `{package name}` with the name of the package you want to work with. eg.: `trader`, `bot`)
[comment]: <> (2. Install all packages with a hoisting strategy \(lift all common packages to a root `node_modules` and not package specific\), run `npm run hoist`)

How to work with this repo
=============================

## Working With This Repo
All packages must contain the following scripts to perform the stated actions:

| Command | Description |
Expand All @@ -37,8 +43,14 @@ All packages must contain the following scripts to perform the stated actions:
| `deploy:production` | Initiates procedures for deploying to production. (Package specific) |

**Please follow the README of each package you intend to work with on how to get set up.** However, the above scripts can be run from the root directory in the following manner.
## Usage
### Example

### Usage
#### How to Clean Packages
If you intend to remove `node_modules` folder(s) from the projects, please run `lerna clean` and follow the instructions.

You can read more on the various lerna commands (and the `clean` command) over at the [Lerna docs](https://github.com/lerna/lerna/).

#### Examples
In order to run the `start` script for all packages (`trader`, `bot`, etc.), simply `cd` to the root of the repo and run:
```bash
npm run start
Expand All @@ -58,19 +70,11 @@ npm run deploy:folder trader br_test_folder
You can find the names of packages by first navigating to the `packages` folder. Each subfolder is a package, and contains a `package.json` file. The value of the `name` key in `package.json` is the package name.

### PR Guidelines

1. Use the `developer 1|developer 2/task_name` format for PR titles. (e.g.: `dev1/fixed_emoji_issue`)
2. Use the appropriate package labels available on the repo to indicate which packages your PR modifies.
3. Use Draft PRs if you don't mean to request for reviews yet. [Read more here.](https://github.blog/2019-02-14-introducing-draft-pull-requests/)

### Clean projects

If you intend to remove `node_modules` folder(s) from the projects, please run `lerna clean` and follow the intstructions.

You can read more on the various lerna commands (and the `clean` command) over at the [Lerna docs](https://github.com/lerna/lerna/).

### FAQ

1. If you have to use `sudo -s` in your environment, please remove any hardcoded `sudo` from `packages/*` (eg., remove `sudo` from `start` and `serve` commands of `packages/trader`)

2. How do I install a package?
Expand Down