Difference between revisions of "The Scurvy Curs"

From CDOT Wiki
Jump to: navigation, search
(→‎Milestone 0.4)
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
= The Scurvy Curs (Team XV)=
 
= The Scurvy Curs (Team XV)=
 
== Project Marking Percentage ==
 
== Project Marking Percentage ==
−
* due immediately
+
 
 
<big>
 
<big>
−
  Group work:      XX%       (25 <= xx <= 50)
+
  Group work:      50%    
−
  Individual work: XX% +     (50 <= xx <= 75)
+
  Individual work: 50% +  
 
  -------------------------
 
  -------------------------
 
  Total          100%
 
  Total          100%
 
</big>
 
</big>
 +
 
== Repository ==
 
== Repository ==
 
* repo Github id:  
 
* repo Github id:  
Line 17: Line 18:
 
|[[User:Savakian1 | Saro]]|| Avakian || B || [mailto:savakian1@myseneca.ca?subject=oop344 savakian1] || Github:[http://github.com/saro-avakian saro-avakian]
 
|[[User:Savakian1 | Saro]]|| Avakian || B || [mailto:savakian1@myseneca.ca?subject=oop344 savakian1] || Github:[http://github.com/saro-avakian saro-avakian]
 
|[[Special:Contributions/Savakian1 | Savakian1]] ||skullman || [http://skullman012291@blogspot.ca Skullman's Blog]
 
|[[Special:Contributions/Savakian1 | Savakian1]] ||skullman || [http://skullman012291@blogspot.ca Skullman's Blog]
 +
|-
 +
|[[User:Marcus Gauer | Marcus]]|| Gauer || A || [mailto:mgauer@myseneca.ca?subject=oop344 mgauer] || Github:[http://github.com/gauer gauer] || [[Special:Contributions/Marcus Gauer | Marcus Gauer]] || wizardsgambit || [http://http://gambitkun.blogspot.ca/ Epic Adventures]
 +
|-
 +
|[[User:Samuel Azan | Samuel]]|| Azan || B || [mailto:sbazan@myseneca.ca?subject=oop344 sbazan] || Github:[http://github.com/samuel-azan samuel-azan]
 +
|[[Special:Contributions/Samuel Azan | Samuel Benjamin Azan]] || samuel-azan || [http://samoop.blogspot.ca/ Sam OOP344]
 +
|-
 +
|[[User:Kieran Sedgwick|Kieran]]||Sedgwick||A||[mailto:ksedgwick@myseneca.ca?subject=oop344 ksedgwick ]|| Github:[http://github.com/ksedge ksedge] || [[Special:Contributions/Kieran Sedgwick|Kieran Sedgwick]]||ksedge|| [http://ksedge.blogspot.ca/ k.sedge Does OOP344]
 +
|-
 +
 +
|[[User:Yoav Gurevich | Yoav]]|| Gurevich || A || [mailto:ygurevich@myseneca.ca?subject=oop344 ygurevich] || Github:[http://github.com/yoavgurevich yoavgurevich] || [[Special:Contributions/Yoav Gurevich | Yoav Gurevich]] || Schmagurv || [http://ygs3.blogspot.ca/ Yoav' OOP344 Blog]
 +
 
|-
 
|-
 
<!-- use this to add rows to this table:
 
<!-- use this to add rows to this table:
Line 22: Line 34:
 
|-
 
|-
 
-->
 
-->
 +
 +
 +
|}
 +
 +
==Issues and Status ==
 +
 +
 +
 +
====Milestone 0.2====
 +
{| class="wikitable sortable" border="1" cellpadding="5"
 +
! Issue # !! Description  !! Assigned To !! Pull Request !! Completed?
 +
|-
 +
| 1 || Add console class || Marcus || Kieran || '''Y'''
 +
|-
 +
|-
 +
| 2.1 || CField Mock-up Class || Marcus || Yoav || Y
 +
|-
 +
|-
 +
| 2.2 || CLabel Mock-up Class || Kieran || Samuel || Y
 +
|-
 +
|-
 +
| 2.3 || CDialog Mock-up Class || Kieran || Yoav || Y
 +
|-
 +
|-
 +
| 2.4 || CLineEdit Mock-up Class || Yoav || Kieran || Y
 +
|-
 +
|-
 +
| 2.5 || CButton Mock-up Class || Yoav || Marcus || Y
 +
|-
 +
|-
 +
| 2.6 || CValEdit Mock-up Class || Kieran || Marcus || Y
 +
|-
 +
|-
 +
| 2.7 || CCheckMark Mock-up Class || Samuel || Marcus || Y
 +
|-
 +
|-
 +
| 2.8.1 || Add Text Class to the project || Samuel || Marcus || Y
 +
|-
 +
|-
 +
| 2.8.2 || CText Mock-up Class || Samuel || Marcus || Y
 +
|-
 +
|-
 +
| 2.9 || CCheckList Mock-up Class || Marcus || Samuel || Y
 +
|-
 +
 +
<!-- use this to add rows to this table:
 +
| ISSUE NUMBER || ISSUE DESCRIPTION || WHO IS DOING THE ISSUE || WHO IS DOING THE PULL REQUEST || Y/N
 +
|-
 +
-->
 +
|}
 +
 +
 +
 +
 +
====Milestone 0.3====
 +
 +
 +
{| class="wikitable sortable" border="1" cellpadding="5"
 +
! Issue # !! Description  !! Assigned To !! Pull Request !! First Pull !! Drop-Dead || Completed
 +
|-
 +
| 1 || Implement CField || Marcus || Kieran || n/a || 11/15/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
| 2 || Implement CDialog || Kieran & Saro || Marcus || 11/17/12 @ 11:59pm  || 11/18/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
 +
| 3 || Implement CLabel || Yoav || Samuel || 11/17/12 @ 11:59pm  || 11/18/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
 +
 +
| 4 || Implement CLineEdit || Marcus & Samuel || Yoav || n/a  || 11/19/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
 +
<!-- use this to add rows to this table:
 +
| ISSUE NUMBER || ISSUE DESCRIPTION || WHO IS DOING THE ISSUE || WHO IS DOING THE PULL REQUEST || FIRST PULL DEADLINE || Drop-Dead DEADLINE || '''Y or N'''
 +
|-
 +
-->
 +
|}
 +
 +
 +
 +
 +
 +
====Milestone 0.4====
 +
{| class="wikitable sortable" border="1" cellpadding="5"
 +
! Issue # !! Description  !! Assigned To !! Pull Request !! First Pull !! Drop-Dead || Completed
 +
|-
 +
| 1 CButton || Implement CButton || Marcus || Kieran || n/a || n/a|| '''Y'''
 +
|-
 +
 +
| 2.0 || CValEdit Testing  || Marcus || Kieran || n/a || 11/25/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
| 2.1 || CValEdit Constructors/Destructors || Yoav || Marcus || 11/23/12 @ 11:59pm || 11/24/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
| 2.2 || CValEdit Edit() || Saro || Marcus || 11/23/12 @ 11:59pm || 11/24/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
| 3.1 || CCheckMark Constructors || Yoav || Kieran || 11/23/12 @ 11:59pm || 11/24/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
| 3.2  || CCheckMark Draw()/Set()/Other() || Samuel || Kieran || 11/23/12 @ 11:59pm || 11/24/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
| 3.3  || CCheckMark Edit() || Samuel || Marcus || 11/23/12 @ 11:59pm || 11/24/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
| 3.4  || CCheckMark Testing || Kieran || Marcus || n/a || 11/25/12 @ 11:59pm || '''Y'''
 +
|-
 +
 +
 +
<!-- use this to add rows to this table:
 +
| ISSUE NUMBER || ISSUE DESCRIPTION || WHO IS DOING THE ISSUE || WHO IS DOING THE PULL REQUEST || FIRST PULL DEADLINE || Drop-Dead DEADLINE || '''Y or N'''
 +
|-
 +
-->
 +
|}
 +
 +
== Coding Rules ==
 +
 +
All of our code '''must''' follow the following standards.
 +
 +
==== Conventions ====
 +
* When creating header files remember to protect them by using ifndef.
 +
 +
<pre>
 +
 +
#pragma once
 +
 +
#ifndef __XX_FILENAME_H__  //where XX is your initials and FILENAME is the name of the file
 +
 +
#define __XX_FILENAME_H__
 +
 +
//codehere
 +
 +
#endif
 +
 +
</pre>
 +
 +
* Always always ''always'' simplify code so it is easily readable! E.G.
 +
<pre>
 +
c += !!(valid);  // NOT THIS
 +
 +
if (valid) {  // INSTEAD THIS
 +
  c++;
 +
}
 +
</pre>
 +
 +
* If confusing code cannot be avoided, ''comment it''! E.G.
 +
 +
<pre>
 +
c += !!(validNames);  // If [validNames] is true (greater than 0), [c] is increased by one.
 +
</pre>
 +
 +
==== Format ====
 +
* All indents must be composed of two space characters E.G.
 +
<pre>
 +
Where . = space
 +
 +
First code level
 +
..Second code level
 +
....Third Code level
 +
..Second code level
 +
....Third Code level
 +
......Fourth Code level
 +
....Third code level
 +
..Second code level
 +
First code level
 +
</pre>
 +
 +
* All variables must be declared on separate lines E.G.
 +
 +
<pre>
 +
int i, j, k;  // NOT THIS
 +
 +
int i; // INSTEAD THIS
 +
int j;
 +
int k;
 +
</pre>
 +
 +
* Code blocks are formatted like the following:
 +
 +
<pre>
 +
if (condition) {
 +
  // THIS
 +
}
 +
 +
vs
 +
 +
if (condition)
 +
{
 +
  // NOT THIS
 +
}
 +
</pre>
 +
 +
* Conditions for logic statements (if, while etc.) must be spaced like the following:
 +
 +
<pre>
 +
if (a > b)  // Brackets wrap a simple condition
 +
 +
OR
 +
 +
if ( (strlen(blah) - 1) > methodA(b) ) // If statement brackets are 1 space away from conditions
 +
</pre>
 +
 +
* ELSE statements must be spaced like the following:
 +
 +
<pre>
 +
 +
if (condition) {
 +
  // Code here
 +
}  < -------- THIS!
 +
else {
 +
  // Code here
 +
}
 +
 +
VS
 +
 +
if (condition) {
 +
  // Code here
 +
} else {  <------------ NOT THIS!
 +
  // Code here
 +
}
 +
</pre>
 +
 +
==== Comments ====
 +
* Before a method/function E.G.
 +
 +
<pre>
 +
/**************
 +
* methodName *
 +
**********************************
 +
* Concise description of purpose *
 +
**********************************/
 +
void methodName ( type paramName ) {
 +
  // CODE HERE
 +
}
 +
</pre>
 +
 +
* Before and after blocks of logic E.G.
 +
 +
<pre>
 +
main() {
 +
    // Begin (CODE BLOCK PURPOSE HERE)
 +
    CODE HERE
 +
    // End (CODE BLOCK PURPOSE HERE - Optional, depending on length of code block)
 +
}
 +
</pre>
 +
 +
* After lengthy logic constructs (if, while, for etc.) E.G.
 +
 +
<pre>
 +
if (condition) {
 +
 +
  // many lines of code
 +
 +
} // End-if < -------- THIS PART
 +
</pre>
 +
 +
== Meetings ==
 +
* latest will be on top
 +
# [[(Irc)logs of meeting number ### - oop344 20113 | topic and date1 ]]
 +
# [[(Irc)logs of meeting number ### - oop344 20113 | topic and date2 ]]
 +
 +
== discussions ==

Latest revision as of 13:28, 6 December 2012

The Scurvy Curs (Team XV)

Project Marking Percentage

Group work:      50%      
Individual work: 50% +    
-------------------------
Total           100%

Repository

  • repo Github id:

Team Members

The Scurvy Curs (Team XV)
First Name Last Name Section Seneca Id Github ID wiki id IRC nick Blog URL
Saro Avakian B savakian1 Github:saro-avakian Savakian1 skullman Skullman's Blog
Marcus Gauer A mgauer Github:gauer Marcus Gauer wizardsgambit Epic Adventures
Samuel Azan B sbazan Github:samuel-azan Samuel Benjamin Azan samuel-azan Sam OOP344
Kieran Sedgwick A ksedgwick Github:ksedge Kieran Sedgwick ksedge k.sedge Does OOP344
Yoav Gurevich A ygurevich Github:yoavgurevich Yoav Gurevich Schmagurv Yoav' OOP344 Blog

Issues and Status

Milestone 0.2

Issue # Description Assigned To Pull Request Completed?
1 Add console class Marcus Kieran Y
2.1 CField Mock-up Class Marcus Yoav Y
2.2 CLabel Mock-up Class Kieran Samuel Y
2.3 CDialog Mock-up Class Kieran Yoav Y
2.4 CLineEdit Mock-up Class Yoav Kieran Y
2.5 CButton Mock-up Class Yoav Marcus Y
2.6 CValEdit Mock-up Class Kieran Marcus Y
2.7 CCheckMark Mock-up Class Samuel Marcus Y
2.8.1 Add Text Class to the project Samuel Marcus Y
2.8.2 CText Mock-up Class Samuel Marcus Y
2.9 CCheckList Mock-up Class Marcus Samuel Y



Milestone 0.3

Issue # Description Assigned To Pull Request First Pull Drop-Dead Completed
1 Implement CField Marcus Kieran n/a 11/15/12 @ 11:59pm Y
2 Implement CDialog Kieran & Saro Marcus 11/17/12 @ 11:59pm 11/18/12 @ 11:59pm Y
3 Implement CLabel Yoav Samuel 11/17/12 @ 11:59pm 11/18/12 @ 11:59pm Y
4 Implement CLineEdit Marcus & Samuel Yoav n/a 11/19/12 @ 11:59pm Y



Milestone 0.4

Issue # Description Assigned To Pull Request First Pull Drop-Dead Completed
1 CButton Implement CButton Marcus Kieran n/a n/a Y
2.0 CValEdit Testing Marcus Kieran n/a 11/25/12 @ 11:59pm Y
2.1 CValEdit Constructors/Destructors Yoav Marcus 11/23/12 @ 11:59pm 11/24/12 @ 11:59pm Y
2.2 CValEdit Edit() Saro Marcus 11/23/12 @ 11:59pm 11/24/12 @ 11:59pm Y
3.1 CCheckMark Constructors Yoav Kieran 11/23/12 @ 11:59pm 11/24/12 @ 11:59pm Y
3.2 CCheckMark Draw()/Set()/Other() Samuel Kieran 11/23/12 @ 11:59pm 11/24/12 @ 11:59pm Y
3.3 CCheckMark Edit() Samuel Marcus 11/23/12 @ 11:59pm 11/24/12 @ 11:59pm Y
3.4 CCheckMark Testing Kieran Marcus n/a 11/25/12 @ 11:59pm Y

Coding Rules

All of our code must follow the following standards.

Conventions

  • When creating header files remember to protect them by using ifndef.

#pragma once

#ifndef __XX_FILENAME_H__  //where XX is your initials and FILENAME is the name of the file

#define __XX_FILENAME_H__ 

//codehere

#endif
  • Always always always simplify code so it is easily readable! E.G.
c += !!(valid);  // NOT THIS

if (valid) {   // INSTEAD THIS
  c++;
}
  • If confusing code cannot be avoided, comment it! E.G.
c += !!(validNames);  // If [validNames] is true (greater than 0), [c] is increased by one.

Format

  • All indents must be composed of two space characters E.G.
Where . = space

First code level
..Second code level
....Third Code level
..Second code level
....Third Code level
......Fourth Code level
....Third code level
..Second code level
First code level
  • All variables must be declared on separate lines E.G.
int i, j, k;  // NOT THIS

int i; // INSTEAD THIS
int j;
int k;
  • Code blocks are formatted like the following:
if (condition) {
  // THIS
}

vs

if (condition) 
{
  // NOT THIS
}
  • Conditions for logic statements (if, while etc.) must be spaced like the following:
if (a > b)  // Brackets wrap a simple condition

OR

if ( (strlen(blah) - 1) > methodA(b) ) // If statement brackets are 1 space away from conditions
  • ELSE statements must be spaced like the following:

if (condition) {
  // Code here
}  < -------- THIS!
else {
  // Code here
}

VS

if (condition) {
  // Code here
} else {  <------------ NOT THIS!
  // Code here
}

Comments

  • Before a method/function E.G.
/**************
 * methodName *
 **********************************
 * Concise description of purpose *
 **********************************/
void methodName ( type paramName ) {
  // CODE HERE
}
  • Before and after blocks of logic E.G.
main() {
    // Begin (CODE BLOCK PURPOSE HERE)
    CODE HERE
    // End (CODE BLOCK PURPOSE HERE - Optional, depending on length of code block)
}
  • After lengthy logic constructs (if, while, for etc.) E.G.
if (condition) {

  // many lines of code

} // End-if < -------- THIS PART

Meetings

  • latest will be on top
  1. topic and date1
  2. topic and date2

discussions

Retrieved from "https://wiki.cdot.senecapolytechnic.ca/w/index.php?title=The_Scurvy_Curs&oldid=91876"