cs487 - Software Engineering I - Fall 2016
Before you get started
This class requires you to do a LOT of work between reading assignments, a pretty large project, and a final exam.
Grading is quite strict as well, in that failure to get a passing grade in, say, the project will earn you a failing grade in this class. Put it another way, you cannot get around work by skipping assignments and hoping to pass based on a good class average.
I highly encourage you to read these books, you'll discover that you'll keep them around you for your entire career as a professional Software Engineer.
The following grading scale will be used to determine your grade in this class:
To pass this class you will need to have the following marks:
Please read this again since it is not your typical grading policy.
Class participation will help settle borderline grades. While class attendance is not taken, your instructor believes that regular class attendance is important and expects students to actively participate in class. Questions and comments are always welcome.
All work that you turn in must be submitted on the Blackboard before midnight (Central Time) the day the work is due.
Late work is penalized at the rate of 5% per calendar day.
There is no late work in this class, really. The deadline for the project is 11/28/16, which means that if you fail to deliver, the only things you can get are a failing grade or an incomplete, depending on circumstances.
Same thing for the weekly project status updates that you have to deliver to your peers, live if you are in the main section, or in writing if you work on the project individually. If you don't have your status update, then you'll get penalized for failure to deliver and we move on.
Your teacher will try to accommodate you in those cases that are beyond your control, such as medical and personal emergencies. Please note that, based on circumstances, the teacher may decide to assign you an incomplete grade, "I", or otherwise ask you to drop the class.
Incomplete ("I") Grades
Yes, you can get an incomplete in this class even if you're not dealing with a personal emergency. Here are the conditions:
All the work you submit must be individual, including, but not limited to, those cases when your instructor has approved pair-programming for you; in these cases the only thing that may be identical with somebody else's is code.
Academic dishonesty will not be tolerated. IIT has a strict academic honesty policy; here are the top points:
You can read IIT's Code of Academic Honesty here. You should read it until you fully understand it. A good way to test whether you understand it is to try to explain it to somebody else.
There are multiple ways you can receive extra credit in this class, here are some:
Exams are open-book(s), open-notes and comprehensive. You may bring with you any notes you want, however you may not share them with anybody else during the exam.
During the exam the use of communication devices such as phones and computers is not allowed. You may bring with you a calculator if you think you need one.
Work done using languages other than specified above, as well as the linking of free and open-source software with proprietary 3rd party libraries will not be accepted.
To learn more about free software check out the Free Software Foundation.
You should also know that free software is not the same thing as open-source software, this article from the GNU foundation clarifies the matter for you.
All programming work you do for this class will be tested on *our* computer(s) running a fresh instalation of Ubuntu 16.04 LTS (Xenial Xerus).
I'm sorry, but the fact that your code runs on your computer and not on ours is not enough to earn you credit for your work.
If you've been using Linux, then this requirement is very easy to satisfy. If you're new to Linux, then you'll have some learning to do, which is a very good and valuable thing.
Let me repeat, we're not going to test under any version of Windows, nor are we going to do it under any other Unix variant other than the one described above.
If you're building a mobile application, then we'll use the simulator/emulator that comes with iOS or Android.
If we ask you to demo your project, then you'll have to do it in the test environment specified above. A full demo will require you to do the following:
You typically have 30' for the demo.
If your application requires things (e.g. libraries, plug-ins, gems, etc.) that don't come with the standard Linux distribution, then you should tell us, in the README file you provide with your other deliverables, how to install required dependencies. Better yet, your build script will install all that's needed for a successful demo.
We're all tired of bad software, whether because it crashes when we least expect it or because of security holes that allow the bad guys to take over our systems and identities. We all pretty much despise software maintenance, in particular when we're asked to modify code that we never touched, don't really understand, and have no way of making sure our changes don't damage existing functionality.
The good news is that we can do something about it: creating automated unit tests for all your code is a very good start. Doing it in Test-Driven Development (TDD) fashion is even better.
You cannot possibly get full credit for your work unless each and every method in your classes has good unit testing. By good I mean meaningful and sufficient:
You will be required to measure and include with your deliverables the unit test coverage as measured by the tool of choice in your chosen programming language, e.g. jCoverage for Java, Rcov for Ruby, etc.
As a general rule automated unit testing will account for 50% of your mark in any assignment, of which 3/5 is assigned to unit test coverage, and the other 2/5 will be awarded based on how good your tests are.
If you fail to submit unit testing, then you cannot expect to get more than 50% in the assignment.
Unit test coverage above 80% is required for full credit. Unit test coverage below 50% doesn't earn you any credit. For anything in between, you get one percentage point of credit for each percentage point of unit test coverage. For example, if your test coverage is 73%, then the most credit you can get for unit testing is 30-(80-73)=23. In another example, if the unit test coverage is 51%, then the most credit you can get is 30-(80-51)=1.
Unit tests that are useless will be removed and the coverage will be measured again before a mark is assigned for your work.
Typically the first person you should contact for any questions related to assignments is your TA.
Please be descriptive in the subject line when you email your instructor such that processing doesn't get delayed. At the very minimum you should indicate the class and the term, followed by a brief description of what is it that you want to communicate.
Examples of good subject lines for your email:
You are required to submit your work online, using the Blackboard. Late work will be accepted, however it is subject to the late penalties described in this syllabus.
Here are the requirements:
The true measure of good Software Engineering is working software delivered on time--not much of a choice here since the delivery date is fixed--and that satisfies the customer expectations. Your budget is fixed too since you cannot add new members to the team.
The only way you can complete the project by the end of this semester is if you work using an agile methodology. Each iteration is one week long.
If you are in section #1 (live, Main Campus), then you'll do the project as part of a team of 4-5. Students in all the other sections will work on individual projects.
You should work on creating a team or becoming part of a team. Your instructor doesn't like assigning students to teams.
If you have an idea, then pitch it to your peers and get them to join your team. In this case you are the customer and the delivery team which makes for some interesting challenges: you're more like an entrepreneur than a small company that delivers software on to paying customers.
If you are part of a team that works on a sponsored project, then your instructor is your customer; he will provide the high-level requirements for the project, answer your questions, etc.
If you are not in the live section (aka Main Campus), then you'll have to work on a project on your own. Choose a topic and run it by your instructor to make sure it's reasonably simple but not too much so.
Your instructor will assign you a project topic only if all else has failed.
All work you do is FOSS. Your instructor prefers GNU's GPL, however for purposes of this class you may use any of the open-source licenses that are popular, e.g. Apache, MIT, FreeBSD.
Each team and each student who does an individual project will need to submit a weekly status on the Blackboard. Teams will need to deliver their status live - in front of the class - as well.
Here's what needs to be in the weekly status:
NOTE: You have to deliver a status even on those weeks when we don't have class.
Project Management and Collaboration
As a team you'll need a way to collaborate on your project. Keeping track of stories and who's working on them, issues, defects, group discussion, etc. are things that are best done using a tool. Some like Pivotal Tracker, others like Bitbucket, and yet others are totally fine using Google Docs and Groups. Slack is a very fine tool for team communications.
I strongly encourage you to stay away from email and Excel spreadsheets. Spend a day as team researching what's out there, choose something that looks reasonable and doesn't cost money and go for it. Remember, in the end it's just a tool and no tool is perfect.
Last but not least, you have to invite your instructor and your TA to your project management/collaboration account.
Each team member is expected to write code for their respective project. We expect to see frequent commits to the code repository you have chosen for your project.
Since your project is FOSS, you're going to use a public repository where the public at large has read access and only the team members are allowed to commit code.
Your instructor reserves the right to change this schedule.
For more important dates and detail go to the IIT site.
Americans with Disabilities Act (ADA)
Reasonable accommodations will be made for students with documented disabilities. In order to receive accommodations, students must obtain a letter of accommodation from the Center for Disability Resources. The Center for Disability Resources (CDR) is located in 3424 S. State St., room 1C3-2 (on the first floor).
Unless otherwise stated all papers you turn in will be TYPED. No handwritten work is accepted.
Each page will have a header as follows:
Each page will also have a footer:
$Id: syllabus.html,v 1.2 2016/09/13 14:29:33 virgil Exp $