forked from waruto210/tinysql
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update readme.md and add classroom.md to describe the classroom usage (…
…talent-plan#137) * add classroom.md and update README.md for classroom Co-authored-by: yanguwan <[email protected]>
- Loading branch information
1 parent
ecf46f1
commit eb8acfa
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# GitHub Classroom | ||
|
||
We mainly use [GitHub classroom](https://classroom.github.com/) to manage the working progress. After joining a tinySQL classroom, you're able to have your own private working repository and the CI will run the test scripts on your commits. | ||
|
||
This document talks about the classroom usage. | ||
|
||
## Join the Classroom | ||
|
||
There is an invitation link for a tinySQL classroom, they look like `https://classroom.github.com/a/hashStr`, the *hashStr* will be replaced with a real value. Visit the invitation link and accept this assignment. | ||
|
||
![](./docs/images/accept.png) | ||
|
||
After that, we will create a private tinySQL repo under the orgnization talent-plan for you. You always can find the repo entry through the invitation link. | ||
|
||
## Get a Classroom Invitation | ||
|
||
Since June 2022, tinySQL learning activities will run in two ways. One is learning camps organized periodically by Talent Plan community, you can get the learning camps information and invitation link from [here](https://github.com/talent-plan). The other one is the traditiona way, you can package all the tinySQL code and send to [[email protected]](mailto:[email protected]) with the subject **Apply for review of tinySQL labs** | ||
|
||
## Autograding | ||
|
||
Autograding is a workflow which can automatically run test cases and give feedback timely. However there are some limitations in Github classroom, in order to make golang work and run it in our self-hosted machines, **you need to overwrite the workflow generated by Github classroom and commit it**. | ||
|
||
```sh | ||
cp scripts/classroom.yml .github/workflows/classroom.yml | ||
git add .github | ||
git commit -m"update github classroom workflow" | ||
``` | ||
|
||
## Commit Your Work | ||
|
||
Now you're able to work on your local copy. Once you are ready to try with CI(feel free to use CI), commit your changes and push them to your `course` branch. | ||
|
||
On your push, the CI script will start to run and you can check the progress by click the 'Actions' of your private repo. | ||
|
||
|
||
|
||
![](./docs/images/actions.png) | ||
|
||
|
||
After implementing all labs, the CI passed 🚀. | ||
|