Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 4.05 KB

How to contribute

Since the repo is maintained by myself, I'd be very grateful if you could contribute to this repo, and there won't be any complex "procedure". Here are some things to contribute:

  • Fix typo: If you find any typo in the notes, please feel free to create a PR.

  • Add notes: I'm not a note-taking guy so in most courses I would not summarize the notes. If you have notes of the courses in this repo, please feel free to add it here. (Don't forget to add your name in the notes!)

  • Fix assignments: If you find any mistakes in the assignments, please directly fix them in PRs with your explanation.

  • Add more semesters: I don't like it to be out-dated so if you have notes of the courses in the following semesters, please feel free to add it here and refactoring like CS109

    • CSxxx/Assignments... -> CSxxx/Fall 2022/Assignments...
    • And then add your semester CSxxx/Spring 2024/README.md...

    If you introduce new courses, please also update READMEs. Or you can just leave it to me.

  • Composing wiki: I'm thinking of starting a wiki for the repo. For now it's barely a mirror of READMEs but I'd like them to be more detailed. If you have any ideas, please feel free to add them in the wiki.s

如何贡献

因为本仓库是由我一个人维护的，所以如果你能为本仓库贡献，我将不胜感激，而且不会有任何繁琐的“流程”。以下是一些你可以考虑贡献的：

  • 修正错别字：如果你在笔记中发现任何错别字，请随时修改。

  • 添加笔记：我不是一个爱记笔记的人，所以在大多数课程中我不会总结笔记。如果你有这个仓库中课程的笔记，请随时添加在这里。（不要忘记在笔记中添加你的名字！）

  • 修正作业：如果你发现作业中有任何错误，请直接在 PR 中修正，并附上你的解释。

  • 添加更多学期：我不希望这个仓库过时，所以如果你有其他学期的课程资料，请随时添加在这里并重构文件结构，如 CS109

    • CSxxx/Assignments... -> CSxxx/Fall 2022/Assignments...
    • 然后添加你的学期 CSxxx/Spring 2024/README.md...

    如果你添加了新课程，请同时更新README。当然也可以把杂活给其他维护者。

  • 撰写 wiki：我正在考虑为仓库启动一个 wiki。目前它几乎只是 README 的镜像，但我希望它们不止于此。如果你有任何想法，欢迎添加到 wiki 中。

投稿方法

このレポは私自身がメンテナンスしているので、もしあなたがこのレポに貢献してくれるならとてもありがたい。貢献できることは以下の通りです：

  • 誤植の修正：もしノートに誤植を見つけたら、遠慮なくPRを作成してください。

  • 注釈の追加： 私はノートを取るタイプではないので、ほとんどのコースではノートを要約することはありません。もしこのレポにあるコースのノートをお持ちでしたら、遠慮なくここに追加してください。(ノートに名前を書くのを忘れないでください）。

  • 課題の修正：課題に間違いを見つけたら、説明とともにPRで直接修正してください。

  • 学期を増やす：CS109のようにリファクタリングしてください。

    • CSxxx/Assignments... -> CSxxx/Fall 2022/Assignments...
    • そして、あなたの学期 CSxxx/Spring 2024/README.md... を追加してください。

    新しいコースを導入する場合は、READMEも更新してください。あるいは私に任せてください。

  • ウィキの作成： レポのwikiを作ろうと思っています。今のところREADMEのミラーがやっとですが、もっと詳細なものにしたいと思っています。何かアイデアがあれば、遠慮なくwiki.sに追加してください。