Skip to content
This repository was archived by the owner on Apr 18, 2025. It is now read-only.

Commit c070835

Browse files
committed
update guidance
1 parent 6ff65de commit c070835

File tree

2 files changed

+4
-32
lines changed

2 files changed

+4
-32
lines changed

HOW_TO_REVIEW.md

+3-17
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
<!--
2-
Do not edit this file.
3-
Make a change to the template and then pull changes
4-
Repo: https://github.com/CodeYourFuture/Module-Template
5-
-->
6-
71
# Everyone reviews code at CYF
82

3+
https://curriculum.codeyourfuture.io/guides/reviewing/
4+
95
Mentors and trainees all review code, and collaborate on improving code quality. We are all helping each other to talk, write, and think about code more clearly.
106

117
We are not reviewing code as if we were to merge this PR into production; we are opening a technical conversation for the purpose of insight and development.
@@ -53,14 +49,4 @@ Use these resources to inform your code review, get unstuck, and improve your un
5349

5450
## Guides
5551

56-
Here's a detailed checklist of the sorts of things we should check code for:
57-
58-
https://syllabus.codeyourfuture.io/guides/marking-guide
59-
60-
Here's a detailed style guide to help us all write clear, high quality code:
61-
62-
https://syllabus.codeyourfuture.io/guides/code-style-guide
63-
64-
Here's some help with giving good feedback during code review:
65-
66-
https://teachertraining.codeyourfuture.io/tasks/code-review
52+
https://curriculum.codeyourfuture.io/guides/reviewing/

contributing.md

+1-15
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,11 @@
1-
<!--
2-
Do not edit this file.
3-
Make a change to the template and then pull changes
4-
Repo: https://github.com/CodeYourFuture/Module-Template
5-
-->
6-
71
# How To Submit Your Coursework
82

93
Use Git & Github to submit your coursework as a pull request.
104

11-
The Github Desktop cheatsheet will help you.
12-
13-
[Github Desktop Cheatsheet](http://syllabus.codeyourfuture.io/git/cheatsheet)
14-
15-
This module will help you submit your coursework.
16-
17-
[Git](http://syllabus.codeyourfuture.io/git/index)
5+
[Creating a pull request](https://curriculum.codeyourfuture.io/guides/create-a-pull-request/)
186

197
## Questions & Help
208

219
Contributing to a remote codebase is a necessary skill for a professional developer. Opening PRs is mandatory at CYF. It is part of the coursework.
2210

2311
If you cannot submit your coursework you **must** post on Slack to get unblocked.
24-
25-
[How to get help](./HOW-TO-GET-HELP.md)

0 commit comments

Comments
 (0)