forked from repo-reviews/repo-reviews.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
for_educators.html
86 lines (76 loc) · 7.06 KB
/
for_educators.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
---
layout: home
title: Repo Reviews
description: Make repos better, together.
permalink: /for_educators
---
<section class="container-lg p-responsive py-5 py-md-6 my-lg-6">
<h2 class="alt-h2 text-center mb-3 mt-lg-6" id="for-educators">For Educators</h2>
<p class="alt-lead text-gray text-center col-md-10 mx-auto">Educators use Repo Reviews as an exercise for students to learn about GitHub and contribute to the open-source community.</p>
<section class="container-lg p-responsive py-5 py-md-6 my-lg-6">
<div class="clearfix gutter-spacious">
<div class="mb-3 mb-md-5 col-md-6 float-left">
<h2 class="alt-h3 mb-2">
<svg height="28" class="octicon octicon-terminal fill-blue d-inline mr-2" aria-label="terminal" viewBox="0 0 24 24" version="1.1" width="28" role="img"><path d="M9.25 12a.75.75 0 01-.22.53l-2.75 2.75a.75.75 0 01-1.06-1.06L7.44 12 5.22 9.78a.75.75 0 111.06-1.06l2.75 2.75c.141.14.22.331.22.53zm2 2a.75.75 0 000 1.5h5a.75.75 0 000-1.5h-5z"></path><path fill-rule="evenodd" d="M0 4.75C0 3.784.784 3 1.75 3h20.5c.966 0 1.75.784 1.75 1.75v14.5A1.75 1.75 0 0122.25 21H1.75A1.75 1.75 0 010 19.25V4.75zm1.75-.25a.25.25 0 00-.25.25v14.5c0 .138.112.25.25.25h20.5a.25.25 0 00.25-.25V4.75a.25.25 0 00-.25-.25H1.75z"></path></svg>
GitHub Fork
</h2>
<p class="text-gray">Code collaboration and review are built into the development process with GitHub. Students start by creating a GitHub account and forking the repo-reviews repo.</p>
</div>
<div class="mb-3 mb-md-5 col-md-6 float-left">
<h2 class="alt-h3 mb-2">
<svg height="28" class="octicon octicon-checklist fill-blue d-inline mr-2" aria-label="checklist" viewBox="0 0 24 24" version="1.1" width="28" role="img"><path d="M3.5 3.75a.25.25 0 01.25-.25h13.5a.25.25 0 01.25.25v10a.75.75 0 001.5 0v-10A1.75 1.75 0 0017.25 2H3.75A1.75 1.75 0 002 3.75v16.5c0 .966.784 1.75 1.75 1.75h7a.75.75 0 000-1.5h-7a.25.25 0 01-.25-.25V3.75z"></path><path d="M6.25 7a.75.75 0 000 1.5h8.5a.75.75 0 000-1.5h-8.5zm-.75 4.75a.75.75 0 01.75-.75h4.5a.75.75 0 010 1.5h-4.5a.75.75 0 01-.75-.75zm16.28 4.53a.75.75 0 10-1.06-1.06l-4.97 4.97-1.97-1.97a.75.75 0 10-1.06 1.06l2.5 2.5a.75.75 0 001.06 0l5.5-5.5z"></path></svg>
Edit YAML & Markdown
</h2>
<p class="text-gray">Students edit the YAML front matter of a review template and create a thoughtful review of a repo of their choice using Markdown.</p>
</div>
</div>
<div class="clearfix gutter-spacious">
<div class="mb-3 mb-md-5 col-md-6 float-left">
<h2 class="alt-h3 mb-2">
<svg height="28" class="octicon octicon-terminal fill-blue d-inline mr-2" aria-label="terminal" viewBox="0 0 24 24" version="1.1" width="28" role="img"><path d="M9.25 12a.75.75 0 01-.22.53l-2.75 2.75a.75.75 0 01-1.06-1.06L7.44 12 5.22 9.78a.75.75 0 111.06-1.06l2.75 2.75c.141.14.22.331.22.53zm2 2a.75.75 0 000 1.5h5a.75.75 0 000-1.5h-5z"></path><path fill-rule="evenodd" d="M0 4.75C0 3.784.784 3 1.75 3h20.5c.966 0 1.75.784 1.75 1.75v14.5A1.75 1.75 0 0122.25 21H1.75A1.75 1.75 0 010 19.25V4.75zm1.75-.25a.25.25 0 00-.25.25v14.5c0 .138.112.25.25.25h20.5a.25.25 0 00.25-.25V4.75a.25.25 0 00-.25-.25H1.75z"></path></svg>
GitHub Pull Requests
</h2>
<p class="text-gray">Students issue a GitHub pull-request (PR) to merge their review into repo-reviews.</p>
</div>
<div class="mb-3 mb-md-5 col-md-6 float-left">
<h2 class="alt-h3 mb-2">
<svg height="28" class="octicon octicon-terminal fill-blue d-inline mr-2" aria-label="terminal" viewBox="0 0 24 24" version="1.1" width="28" role="img"><path d="M9.25 12a.75.75 0 01-.22.53l-2.75 2.75a.75.75 0 01-1.06-1.06L7.44 12 5.22 9.78a.75.75 0 111.06-1.06l2.75 2.75c.141.14.22.331.22.53zm2 2a.75.75 0 000 1.5h5a.75.75 0 000-1.5h-5z"></path><path fill-rule="evenodd" d="M0 4.75C0 3.784.784 3 1.75 3h20.5c.966 0 1.75.784 1.75 1.75v14.5A1.75 1.75 0 0122.25 21H1.75A1.75 1.75 0 010 19.25V4.75zm1.75-.25a.25.25 0 00-.25.25v14.5c0 .138.112.25.25.25h20.5a.25.25 0 00.25-.25V4.75a.25.25 0 00-.25-.25H1.75z"></path></svg>
GitHub Actions & CI
</h2>
<p class="text-gray">Students watch as a GitHub action validates their PR and Continuous Integration incorporates their review into the website.</p>
</div>
</div>
<div class="clearfix gutter-spacious">
<div class="mb-3 mb-md-5 col-md-6 float-left">
<h2 class="alt-h3 mb-2">
<svg height="28" class="octicon octicon-terminal fill-blue d-inline mr-2" aria-label="terminal" viewBox="0 0 24 24" version="1.1" width="28" role="img"><path d="M9.25 12a.75.75 0 01-.22.53l-2.75 2.75a.75.75 0 01-1.06-1.06L7.44 12 5.22 9.78a.75.75 0 111.06-1.06l2.75 2.75c.141.14.22.331.22.53zm2 2a.75.75 0 000 1.5h5a.75.75 0 000-1.5h-5z"></path><path fill-rule="evenodd" d="M0 4.75C0 3.784.784 3 1.75 3h20.5c.966 0 1.75.784 1.75 1.75v14.5A1.75 1.75 0 0122.25 21H1.75A1.75 1.75 0 010 19.25V4.75zm1.75-.25a.25.25 0 00-.25.25v14.5c0 .138.112.25.25.25h20.5a.25.25 0 00.25-.25V4.75a.25.25 0 00-.25-.25H1.75z"></path></svg>
GitHub Issues
</h2>
<p class="text-gray">Students are tagged in an auto-created issue and prompted to share their review with the repo.</p>
</div>
<div class="mb-3 mb-md-5 col-md-6 float-left">
<h2 class="alt-h3 mb-2">
<svg height="28" class="octicon octicon-checklist fill-blue d-inline mr-2" aria-label="checklist" viewBox="0 0 24 24" version="1.1" width="28" role="img"><path d="M3.5 3.75a.25.25 0 01.25-.25h13.5a.25.25 0 01.25.25v10a.75.75 0 001.5 0v-10A1.75 1.75 0 0017.25 2H3.75A1.75 1.75 0 002 3.75v16.5c0 .966.784 1.75 1.75 1.75h7a.75.75 0 000-1.5h-7a.25.25 0 01-.25-.25V3.75z"></path><path d="M6.25 7a.75.75 0 000 1.5h8.5a.75.75 0 000-1.5h-8.5zm-.75 4.75a.75.75 0 01.75-.75h4.5a.75.75 0 010 1.5h-4.5a.75.75 0 01-.75-.75zm16.28 4.53a.75.75 0 10-1.06-1.06l-4.97 4.97-1.97-1.97a.75.75 0 10-1.06 1.06l2.5 2.5a.75.75 0 001.06 0l5.5-5.5z"></path></svg>
Contribute to the community
</h2>
<p class="text-gray">Students experience the joy of contributing to an open-source repo and sharing their experience with the community to increase productivity.</p>
</div>
</div>
<section class="container-lg p-responsive py-5 py-md-6 my-lg-6">
<p class="text-center">
Support the community with a helpful ❤️ repo review ❤️
</p>
<p class="text-center">
<a href="https://github.com/repo-reviews/repo-reviews.github.io/blob/main/create.md" target="_blank" class="btn btn-outline">Create a review→</a>
</p>
</section>
<section class="">
<div class="container-lg p-responsive py-5 py-md-6 ">
<h2 class="alt-h2 text-center mb-3 mt-lg-6" id="testing">Recent Reviews</h2>
<div>
{% assign sorted = site.reviews | reverse %}
{% for review in sorted limit:10 %}
<li>[<a href="https://repo-reviews.github.io/repos/{{review.repository_owner}}_{{review.repository_name}}">{{ review.repository_owner }}/{{ review.repository_name }}</a>] <a href="https://repo-reviews.github.io/authors/{{review.author_github_id}}">@{{ review.author_github_id}}</a> - <a href="https://repo-reviews.github.io/{{review.url | relative_url}}">{{ review.review_title }}</a></li>
{% endfor %}
</div>
</section>