Skip to content

Commit

Permalink
Update use instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tshemsedinov authored and bohdanbulakh committed Jan 29, 2024
1 parent ce3c658 commit 373b0da
Showing 1 changed file with 35 additions and 13 deletions.
48 changes: 35 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,22 @@
- [Asynchronous programming](Skills/Async.md)
- [Node.js and Backend](Skills/NodeJS.md)
- [Multi-paradigm programming](Skills/Paradigms.md)
- [Architecture](Skills/Architecture.md)

## How to use

- Fork repository
- Create branch, for example: `2023-autumn` or `2024-winter`
- In new branch add following levels or leave line untouched in each file as of :
- πŸ‘‚ heard, πŸŽ“ known, πŸ–οΈ used, πŸ™‹ explained, πŸ“’ talked, πŸ”¬ researched, πŸš€ constructed
- Now you can create pull request and merge this to main branch of your fork (prefer single commit: use squash and merge)
- Create branch, for example: `2024-winter`
- In new branch add following levels or leave line untouched in each file:
- `πŸ‘‚ heard`, `πŸŽ“ known`, `πŸ–οΈ used`, `πŸ™‹ explained`, `πŸ“’ talked`, `πŸ”¬ researched`, `πŸš€ constructed`
- You can use just emojis: `πŸ‘‚`, `πŸŽ“`, `πŸ–οΈ`, `πŸ™‹`, `πŸ“’`, `πŸ”¬`, `πŸš€`
- or just text levels: `heard`, `known`, `used`, `explained`, `talked`, `researched`, `constructed`
- or just shorthands: `~` for `heard`, `+` for `known`, `*` for `used`, `!` for `explained`
- Now you can create pull request and merge this to main branch of your fork (not to original repo)
- Pull request will fire Github Actions CI processing which will generate new commit with `Profile/REPORT.md` file with skill analisis and role matching report
- CI processing will fix all simple mistakes in filling and replace shorthands
- If CI processing will detect unrecoverable error it will generate dubug output and you will receive email with link
- Auto-generated commit will also contain bagde in `md` and `html` formats
- Repeat self assessment after course or training
- Now You can compare branches with URL:
- `https://github.com/<YOUR-ACCOUNT>/SelfAssessment/compare/2023-autumn...2024-winter`
Expand All @@ -24,13 +32,27 @@
It should look like following example after filling it out:

```
- Syntax and concepts
- value: πŸ™‹ explained
- identifier: πŸ–οΈ used
- variable: πŸ™‹ explained
- constant: πŸ–οΈ used
- scalar: πŸ–οΈ used
- literal: πŸ‘‚ heard
- expression: πŸ–οΈ used
- heap: πŸŽ“ known
- Syntax
- Value: πŸ™‹ explained
- Identifier: πŸ–οΈ used
- Variable: πŸ™‹ explained
- Constant: πŸ–οΈ used
- Scalar: πŸ–οΈ used
- Literal: πŸ‘‚ heard
- Expression: πŸ–οΈ used
- Heap: πŸŽ“ known
```

Alternative example (will be automatically formatted as above example):

```
- Syntax
- Value !
- Identifier: *
- Variable: !
- Constant *
- Scalar *
- Literal ~
- Expression: *
- Heap: +
```

0 comments on commit 373b0da

Please sign in to comment.