CPSC 480-020 Software Engineering (SE) Fall 2024

This exercise is optional. However, completing this exercise will add points to your Project 1 score.

The exercise is due by Tuesday, Oct 8 at 11:59:59 pm EDT.

In your repository for the Requirements Report is the file Corrected.md. This is an edited version of what you submitted with fixes and improvements to the writing.

To see the difference between these two files, you can use the diff command:

The diff utility is line-oriented. Since many of your lines are quite long (the lines are wrapped when you view them), this may be difficult to read. You can also use the wdiff command:

The codespace for Project 1 has diff and wdiff installed. You will have to start a new codespace to use wdiff. If you want to use wdiff outside of a codespace, install on WSL/Linux apt-get update; apt-get install wdiff, and on macOS brew install wdiff.

Your workflow must be the following:

1. Examine the remaining differences between your original report and the corrected one using diff or wdiff.
2. Select one individual correction
3. Make the correction
4. Commit the correction using an appropriate commit message
5. Push the commit to GitHub
6. Verify at GitHub that the commit is there and the correction is made

Each correction must be a contiguous change. That means that each commit only contains one correction. Practically, this means that each correction/commit will be on a single line.

To get credit, your resulting Requirements.md file must be exactly the same as the Corrected.md file. You will reach this stage when diff shows no differences.

The git commit messages must be in the proper form, such as:

• Fix spelling in story title
• Fix spelling of "calendar"
• Capitalize story title
• Simplify description
• Fix spacing in description
• Add missing article in story title
• Add missing article in general process
• Simplify sentence in user story title

The commit messages must following good git commit message guidelines:

• Use the imperative mood in the subject line, e.g., Fix, not Fixed, Fixing
• Capitalize the subject line, e.g., Fix, not fix
• Do not end the subject line with a period, e.g., Fix spelling of "calendar", not Fix spelling of "calendar".

The score on this exercise will be 0 if the commit messages do not follow the above guidelines, or there is no effort to use an appropriate commit message.

Note:

There will be a lot of commits, so you want to be efficient creating them. After you do the first few corrections, you can push to GitHub and verify at GitHub periodically and not every time. And, to save time with entering commands, bring up previous commands in a shell using the up arrow ⇧ or Ctrl + P, and edit the git commit messages if necessary.