timothytancy/NTU-DSAI.github.io

DSAI-Docs

• DSAI-Docs
  • Installation
  • Local Development
  • Contributing
    • Instructions
    • File location
    • Pull Requests
    • Branch Naming
    • Commit Messages
    • Additional Pointers

This website is a collection of helpful information gathered by the Senios of DSAI to help you have a fruitful and enjoyable time at NTU. Feel free to add your own updates to the site as pull requests.

Installation

yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Contributing

This repository is actively seeking contributions from students. Please read this document carefully before contributing.

Instructions

1. Duplicate the _Sample.md file into the subfolder where you intend to write the content and rename it accordingly. You can visit docusaurus docs for more feature details
2. Create a Pull Request for your update and ensure the following on the panel on the right:
   1. Add an admin as a reviewer to the pull request.
   2. Add yourself as the asignee
   3. Add this project
   4. Add the Documentation label/tag

File location

Ensure that the file you have created is stored in the appropriate location. This repository follows the latest official DSAI curriculum structure and MPE list found here. Modules appearing in the Curriculum Structure are organised by semester, MPEs and BDEs have their own folders respectively with the latter being organised by school. Any module not in the two documents above should be in the BDE section.

Note: More details are provided in the PR Template.

Pull Requests

Please add content to the project by forking the repository and adding your changes in as few commits as possible. Title your PR summarising the content that you're submitting as succintly as possible.

Pull requests that do not follow these instructions will not be accepted.

Branch Naming

All contribution branches are to be named as such:

• Contribution: contribution-<yourname>

• Bug: bug-yourname-<nature of bug>, eg. bug-bhargav-broken-links

Commit Messages

Commit messages should describe the content of the commit, such as:

Added SC1003 Intro to Computational Thinking

or

Added AI, Regression Analysis, Data Visualisation

If you are creating a Pull Request that fixes an Issue, include the issue number in the commit message as such:

[#3] Fixed infinite loop

Additional Pointers

1. For internal Links between pages, use the relative file path rather than the slug link. e.g. (statistics)[../Y2S2/MH3500 Statistics.md] as it aids with linking files on GitHub.