nanyang-system-developers

Contributors

Just promoted to contributor? Check out the guide below to find out more about NYSD Repositories. Getting Started Guide

Responsibilities

• Take on tasks (adding/modifying functions or classes in 1-2 files)
• Pushing code to a feature branch
• Identify bugs and creating issues
• Update documentation for tasks

Minimum expected commitment: ~2 hrs/wk

Training programme

Materials

Programming

• Intro to Python
  • complete all lessons (Advanced + Algorithms)
• Object-oriented programming: Encapsulation
• Object-oriented programming: Dataclasses
• csv & json
• html & css

Security

• Data validation and verification
• Unit testing

Web

• Web requests and responses

Design

• Programming Interfaces (APIs)

AI

Note: contributors are expected to write their own code, without the use of chatbots, although code completion assistants are allowed. This is part of the training to build up sufficient experience for collaborator-level contributions.

• Chatbots
• Code completion assistants

Lifecycle

• Software versioning

Communication

• Docstrings and annotations

Collaboration

NYSD uses GitHub as the central place to manage project-related information.

• Issues are used to track bug reports, requested features
• Pull requests are used to track work in progress and code merges
• Project boards are used to track work allocation and feature progress
• Project roadmaps are used to track project progress, and see if the team is on target to meet milestones

Versioning

• git branching

Process

• commit messages
• code reviews

Assessment

• complete Assignment 3 [Programming]
• complete Assignment 4 [Programming]
• complete Assignment 5 [Programming]

success condition: closing of the feedback PR by your assessors constitutes assignment completion

• Submit an issue report [Collaboration]

success condition: issue report accepted; no requests for information (RFI)

• Complete an assigned task
  • Write a unit test [Security]
  • Write documentation [Communication]
  • Make a pull request [Versioning]

success condition: pull request is approved and merged