Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.82 KB

CONTRIBUTIONS.md

File metadata and controls

56 lines (37 loc) · 2.82 KB

Syntax Comparison Project Contributing Docs

This document contains guides to contributing to this project as well as maintaining the project.

With this in mind, we would like to thank every contributors in investing their time contributing to this project.

Note
To get to a specific section on this docs, click the Table Of Contents icon on the top left corner of this document.

toc_icon

Our Current Contributors

Contributors Role In The Project
1. Lim JY Project creator, General content manager
2. Cheah Zixu Maintenance Administrator
3. Weng Hong :D Java, Javascript and Python content manager
4. JC Chuan C, C++ and C# content manager

New Contributors Guide

To get the overview of this project, take a look at the README.md file. For more info on how to contribute in GitHub, here are some resources that may help you:

If you want to contribute, be sure to read the Design System in our project especially for markdown formatting and structuring. If you are new to markdown syntax, here are some resources that may help you:

More enquiries can be made at here.

Project Folder Structure

Most folders in our project are specific subtopic in the programming basics. Their structures are mostly like this:

  • Subtopic Folder
    • README.md (Contains the theory, syntax comparisons and some additional notes)
    • Sample Codes Folder
      • xxx.cpp (Contains sample code of the subtopic for C++)
      • xxx.java (Contains sample code of the subtopic for Java)
      • xxx.js (Contains sample code of the subtopic for JavaScript)
      • xxx.py (Contains sample code of the subtopic for Python)

Design System

To maintain consistencies at both design and structure of our project, here is the guide to our design system in this project.