Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

70 lines (51 loc) · 3.89 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Intro

Early into the AY12/13 academic year, Prof Tay Yong Chiang organized a supper for Computer Science freshmen at Tembusu College. The bunch of seniors who were gathered there put together a document for NUS computing freshmen. This is that document.

Feel free to create a pull request to edit or add to it, and share it with other freshmen you know.

It is now currently maintained and updated by NUS Hackers.

What is this document?

This document is a living document that aims to provide valuable resources and guidance to incoming computer science freshmen.

The goal of this document

The primary goal of this document is to create a repository of knowledge that will cover various aspects of a freshmen's computing journey. We hope that this document will serve to ease the transition of new students into the School of Computing (SoC).

Contributing to the document

As much as possible, we want to adhere to the the overarching ideas in the awesome manifesto.

In other words:

  • It's curation, not collection. - We want to avoid the document from being too lengthy or diluted.
  • Research if the stuff you're including is actually awesome. - Only put stuff in that you or another contributor can personally recommend.
  • You should rather leave stuff out than include too much. - If you're unsure, ask someone else, or comment it in the PR.
  • Comment on why something is awesome (Not relevant for advice) - If you're recommending a book, or a lecture, tell us why you think it's great.
  • Pay attention to grammar. - Ensure your stuff is grammatically correct, typo-free and has no Markdown formatting errors.

I'm ready to contribute! How do I start?

Make sure your content follows the general principles in Contributing to the document. Follow the checklist, and then submit a pull request!

If you're giving general advice and tips to freshmen

  • Remember to follow the Code of Conduct. We will not approve anything that goes against the Code of Conduct, or is submitted in bad faith.
  • Make sure there are no grammatical errors.
  • There is no specific topic or format you have to follow, but we recommend you to try and give advice on certain topics or areas that other contributors might have missed out on. It doesn't have to be about school life - anything useful, from general programming tips and career advice to life advice, is welcome!

If you want to suggest a new section/list (e.g. favourite programming languages to learn, etc.)

  • Make sure that the section is relevant to the document. If you're not sure, feel free to add an issue to ask us.
  • Make sure that the section is not already covered in the document.
  • Make sure there are no grammatical errors.
  • You should explain why you think the section is great.

If you're adding on to a section/list that already exists

  • Make sure that the item you're adding belongs in the relevant section/list.
  • Make sure that the item you're adding is not already covered in the document.
  • Make sure there are no grammatical errors.
  • You should briefly explain
    • Why you think the item is great
    • What relevance it has to the section/list (Feel free to leave this out if it is obvious).

How to contribute

  • Create a new fork of the document.
  • In your own fork, edit the document and commit it.
    • If you're unfamiliar with markdown, try this.
  • Create a Pull Request (PR) to the main document. See the Pull Request Checklist below.
  • We'll try to review it as soon as possible!