From 5f5d2aa10bd3e5c76f365637baabe77c9ea255c0 Mon Sep 17 00:00:00 2001 From: SalMiah111 <138593086+SalMiah111@users.noreply.github.com> Date: Thu, 13 Jul 2023 22:20:43 +0300 Subject: [PATCH] Update homework-rules.md --- docs/01-getting-started/homework-rules.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/01-getting-started/homework-rules.md b/docs/01-getting-started/homework-rules.md index 9f489f0..f41deff 100644 --- a/docs/01-getting-started/homework-rules.md +++ b/docs/01-getting-started/homework-rules.md @@ -6,12 +6,13 @@ 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`; @@ -19,4 +20,4 @@ The programming assignments adhere to specific guidelines for GitHub repositorie - 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.