Skip to content

Development Guidelines

Casper Nguyen edited this page Oct 9, 2022 · 31 revisions

About

This page contains a set of guidelines and conventions for the entire development process.

Development Process

Understanding our Github

Github is the control center of our project, and we would like everyone, especially developers, to understand it in and out. Remember that status, type, label, and milestones are all used on issues and that we reference issues when those are brought up.

Status

Currently, we have 5 kinds of status. The name of each is self-explanatory:

  • Todo
  • In progress
  • Waiting for Review
  • Under Review
  • Done

Types

We have different kinds of issues:

  • Documentation: For any issue that is not code related.
  • Bug: Reporting a bug.
  • Urgent: For unexpected problems that need to be fixed as soon as possible.
  • Enhancement: For newly proposed features that are not required by the description.
  • Refine: For issues related to refining already working code for better code quality.
  • Abandoned: We shall no longer be working on this issue.

Keep in mind that just being close to the deadline does not make an issue "Urgent". The issue has to be unexpected (might be a bug or a requirement done wrong), close to the deadline, and has significant impact on the project

Labels

Milestones

Conventions

Clone this wiki locally