Skip to content
This repository was archived by the owner on Feb 25, 2018. It is now read-only.

Definitions

Alexander Mark edited this page Nov 15, 2016 · 5 revisions

Definitions

Here are some useful terms you may need when communicating with each other:

The Kanban: The boards under the Projects tab. They're used for tracking the status of various issues. Moving issues around is as easy as drag and drop. Make sure to only move stuff you're directly involved in, though.

 - Product: Most everything goes in here before anywhere else. Issues get tacked to this board for approval before
   going off to development. 

 - Design: The board relating to visual design. In Queue is for design related tickets that are unassigned and 
   haven't been started. In Progress is for tickets that are being worked on by one or more member(s) of the design 
   team. Under Review is for tickets that are done but are awaiting approval. Approved is for designs that are 
   approved. 

 - Development: The board relating to actual programming. In Queue is the same as ever. In Development is for issues 
   that have someone actively programming them. Code Review is for issues that are finished being written but still 
   need people to look over them for adherence to standards among other things. Staging is for issues that have passed
   code review but are only merged onto the GitHub master branch, and therefore not on the actual website yet. In Prod
   is for issues that are merged onto the master branch on the website's server and are on the actual website.

Pull Request / Code Review (PR/CR): A request to merge your branch with another branch. Other users will look over the code you've written and point out various issues it has, and either decide to approve or not approve it. More information on this can be found on the Development Process page, specifically in part 5, 6 and 7.

Standards: How we are going to write our code consistently across many files. Includes thing like naming conventions, whitespace usage, etc. Currently we have none.

Issues: Issues are basically everything we want done regarding the website. For information about how to create an issue, click here.

Feature Request: When you tell someone to make a program do something it doesn't already do, that's most likely going to be a feature request, unless it's a bug.

Bug: Some feature you've implemented isn't working the way you want it to, then it's probably a bug.

Design: Refers to visual design of the website.

Story / User Story: A story that describes a kind of user for our product (in this case, the website) and what type of feature or thing or whatever that user wants the product to do.

Technical Debt: If you solve a problem with an easy to implement solution that isn't the best way to solve a problem, you've created Technical Debt.

Milestone: Milestones are used to group issues that must be completed to finish some larger task, usually described by the name of the milestone.

Blocker: If you can't do one thing because it requires some other thing to be done, then the other thing is a blocker. They're things that need to get done before other things can get done. Block can also be used as a verb to show relationships between issues. ie; #1 blocks #2, or #2 is blocked by #1.

Project Manager (PM): Heads up the whole thing. Does the merges after approvals and a bunch of other stuff. For this project it's Kenny Hong, Ryan Reid and Alex Mark.

Test Driven Development (TDD): A method of developing programs wherein before writing your program, you write tests, based on the requirements that have been laid out, for your functions and other snippets to pass and then program in such a direction that those tests are passed.

Clone this wiki locally