-
Notifications
You must be signed in to change notification settings - Fork 0
Development Guidelines
No experience in development projects is needed, but there are some needed skills.
- A good understanding of C and C++ is a must.
- Understand what is meant by Compiling and Linking in C and C++.
- Know how to set up a compiler in an operating system.
- Know what unit testing is.
In each part of the suite (that is, the assembler, disassembler and debugger) there is a testing directory. In this directory are unit tests for developers to test code changes. Before a commit to GitHub, the code has to past ALL unit tests.
Each class has a unit test, DO NOT alter these unit tests unless you have permission from undertheapi to do so.
Header comments and descriptions on class methods are done in the header file of the class. The implementation should not contain any header comments on class methods, only methods that exist in the implementation file.
Keep the comments meaningful, for example, a bug fix should have a comment:
`
void emptyAList() {
if (!list.isEmpty()) {
list.pop();
}
/*
This is a bug fix. The index was not being reset.
*/
index = 0;
}
`
Try not to do this:
/* increment the index by 1 */ index++;
No new class should be added to the project if you have not consulted ALL members of the development team. A new file is added only if a new feature or a major restructure is needed.