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

Update getting-started/homework-rules.md #81

Merged
merged 1 commit into from
Jul 14, 2023
Merged
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
9 changes: 5 additions & 4 deletions docs/01-getting-started/homework-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,18 @@ hide_table_of_contents: true

We provide a range of homework assignments. You'll begin with stimulating quizzes and then progress to exciting programming tasks.

You receive points for each completed assignment and a chance to own a distinctive NFT from our exclusive collection.
For each completed assignment, you'll receive points and a chance to own a distinctive NFT from our exclusive collection.

The programming assignments adhere to specific guidelines for GitHub repositories, names, pull requests (PR), reviews and regular homework.
The programming assignments adhere to specific guidelines, as highlighted below, for GitHub repositories, names, pull requests (PR), reviews and regular homework.

Guidelines for assignments:
- **SHOULD** be one repo for every homework;
- Repo name **SHOULD** contain `-gear-academy` suffix, e.g. `myname-gear-academy`;
- Repo name **SHOULD** contain the `-gear-academy` suffix, e.g. `myname-gear-academy`;
- Repo **SHOULD** exclude build artifacts like `node_modules`, `target`, editor files, etc.;
- Each homework **SHOULD** be inside the folder named as a block (`hello-world`, `escrow`, `tamagotchi`, `state`, etc);
- Each homework **SHOULD** be a separate PR (helps to review, and add comments) from the feature branch (branched from the `master` or any other working branch) with a block name and a lesson number (`helloworld-1`, `lone-state-2`, `auction-3`, `nft-marketplace-4`, etc.) to the `master`;
- If any changes were requested, updates **SHOULD** be done inside the existing branch and PR;
- Each PR **SHOULD** be merged to the `master` after the homework is accepted;
- Every scaffolding code **SHOULD NOT** be included in PR - private keys, passwords **SHOULD NOT** be included in PR;
- Test & build **SHOULD** pass;
- **MAY** work with `git` from the command line, not using the GitHub web interface.
- **MAY** work with `git` from the command line without using the GitHub web interface.