Skip to content

Commit 6a9493c

Browse files
authored
minor changes
1 parent 38be161 commit 6a9493c

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

Code-Review.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
In order to improve the collaboration and experience with open source development. We expect the following skills to be learned and improved with this initiative:
55

66
1. Usage for GitHub and structure of open source projects.
7-
2. Code readability and documentation
7+
2. Code readability and documentation.
88
3. Creating high level 'wrapper' scripts for simple access to underlying functionality.
99
4. The quality of everyone's GitHub profile.
1010

@@ -14,13 +14,14 @@ In order to improve the collaboration and experience with open source developmen
1414

1515
These are the basic guidelines we expect you to follow.
1616

17-
1. Every check-in requires at least 1 project (_Even if it is as small as MNIST_)
17+
1. Every check-in requires at least 1 project (_Even if it is as small as MNIST_).
1818
2. At least 1 of these projects must have its entire code base on a GitHub repository.
1919
3. Each repository must have the following:
20-
* A README with documentation of what the project aimes to do and general approach used.
21-
* A high level wrapper or executable script to run your code - <i>For example run inference for a single jpeg in case of a machine vision problem</i>
22-
4. Your code must be reviewed by 2 fellow associated who, will join you during your check-in
23-
5. The comments from your reviewers must be incorporated in the for of an "[Issue](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue)" on GitHub.
20+
* A README with documentation of what the project aims to do and general approach used.
21+
* A high-level wrapper or executable script to run your code—<i>for example, run inference for a single jpeg in case of a computer vision problem</i>.
22+
* A list of dependencies or a `requirements.txt` file.
23+
4. Your code must be reviewed by 2 fellow associates who, will join you during your check-in
24+
5. The comments from your reviewers must be incorporated in the for of an [Issue](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue) on GitHub.
2425

2526
## <u>__Hall of Fame__</u>
2627

@@ -30,4 +31,4 @@ The Hall of Fame constitutes of the following:
3031

3132
* The project repository will be *forked* to the [Next Tech Lab GitHub](https://github.com/NextTechLab) and website.
3233
* The project repository will then get the option of posting on medium if the author(s) so choose.
33-
* If the project has the potential, we will assist in creating a Research Paper based on it.
34+
* If the project has the potential, we will assist in creating a research paper based on it.

0 commit comments

Comments
 (0)