Robinson Engineering Academic Guide

罗宾逊工程葵花宝典

What this repository contains

• Table of Contents.md: Table of contents.
• ./contents: All contents of the guide.
• List of abbreviations.md: List of abbreviations.
• README.md: This file.

How to use this repo

• Check last-commit time of files. Some contents, while outdated, provide useful reference.

How to contribute

If you don't know how to use GitHub to contribute to this repo, learn GitHub.

Best practices

Please follow the following best practices when commiting to this repository.

• Use your conscience. Make life easier for the juniors, and others who contribute to this repo.
• Follow the writing structure of the present work. Consistant writing styles are easier to read.
• Be concise. Whenever you type anything, ask yourself, 'is this necessary? Is this really necessary?' If not, delete the redundant text.
• This is an academic guide. Do not include irrelevant topics such as 'Finding supermarkets in Cambridge'.
• Don't over-modularize. Question your impulse to modularize contents. A guide is often more readable if things are in the same document. See the various guides on the teaching website for bad examples.
• Abbreviations. All abbreviations should be spelled out in List of abbreviations.md.
• Use only English, unless you have very good reasons to do otherwise.
• Use a Markdown linter (e.g. the 'markdownlint' VS Code extension) when writing Markdown.

Feedback

• If you have constructive comments regarding this repo, raise a GitHub issue. If you don't know how to raise an issue, learn how to do it.

See also

The Robinson STEM Soc Google Drive contains useful study material, including annotated handouts, notes, and worked solutions to examples papers and past tripos. Please contribute by debugging or updating the folder contents to align with current teaching, but be careful when deleting anything.

Acknowledgements

• 感谢上海交通大学生存指南使我的大学生活格局打开。