Skip to content
This repository was archived by the owner on Mar 24, 2023. It is now read-only.

Commit 194b4e1

Browse files
authored
Update README.md
1 parent a7d2beb commit 194b4e1

File tree

1 file changed

+0
-54
lines changed

1 file changed

+0
-54
lines changed

README.md

-54
Original file line numberDiff line numberDiff line change
@@ -1,55 +1 @@
11
# GlobalLogic JS ProCamp Homework Repo
2-
3-
## Getting started
4-
5-
There is a few steps to get started with your homework.
6-
7-
- First of all you have to click the `Fork` button to make your own repo based on this one.
8-
- Then clone your own repo (i.e. `git clone git@github.com:username/your-forked-repo.git`)
9-
- Before submitting your homework you should check yourself with our public tests. Run `git submodule add git@github.com:vladkampov/gl-jsprocamp-tests.git __tests__` to add tests repo as git submodule.
10-
- To run tests use `npm install && npm test` *(or yarn`?)*
11-
- Post to slack your repo ssh link and you are all set!
12-
13-
## What else
14-
15-
- Note that to make your homework you should use our code convention. [Read More...](#code-convention)
16-
- Feel free to use npm scripts. [Read more...](#scripts)
17-
- Before doing your stuff don't forget to pull the updates from this repo. [Read more...](#rebase-with-base-repo)
18-
- Don't forget to keep updated tests submodule [Read more...](#update-tests)
19-
20-
## Code convention
21-
22-
We are kindly asks you to stick to the following reexporting flow in your project and not change prefedined folders, files and functions names.
23-
24-
### Sources structure
25-
26-
```javascript
27-
- src
28-
|- lesson0
29-
|- task0.js // export default { sum };
30-
|- index.js // import task0 from './task0'; export default { task0 };
31-
...
32-
|- index.js // import lesson0 from './lesson0'; export default { lesson0 };
33-
```
34-
35-
## Scripts
36-
37-
- `npm lint` to check the sources linting
38-
- `npm run coverage` to check the tests coverage
39-
- `npm test` to run tests
40-
- `npm run debug` to run tests with debugger compatibility
41-
- `npm run test:watch` to run tests with `--watch` flag
42-
43-
## Rebase with base repo
44-
45-
To keep your forked repo up to date with current run following commands in your project folder.
46-
47-
```bash
48-
git remote add upstream git@github.com:vladkampov/gl-jsprocamp-homework.git
49-
git fetch upstream
50-
git pull upstream master
51-
```
52-
53-
## Update tests
54-
55-
To keep tests submodule updated use `git submodule update --remote`

0 commit comments

Comments
 (0)