cs101-F2018-lab10-starter

Designed for use with GitHub Classroom, this repository contains the starter for Laboratory 10 in Computer Science 101. Since the Travis builds for this repository will initially fail (as evidenced by a red ✗ appearing in the commit logs instead of a green ✔), the programmer is responsible for completing all of the steps needed to satisfy the requirements for the assignment, thus causing a ✔ to instead appear in the commit logs.

Introduction

Please review the carefully formatted assignment sheet for this project as it provides more details about the steps that a computer scientist should take to complete this assignment. You can view this assignment sheet by visiting the listing of laboratories on the course web site.

When you use the git commit command to transfer your source code to your GitHub repository, Travis CI will initialize a build of your assignment, checking to see if it meets all of the requirements. If both your source code and writing meet all of the established requirements, then you will see a green ✔ in the listing of commits in GitHub. If your submission does not meet the requirements, a red ✗ will appear instead. The instructor will reduce a programmer's grade for this assignment if the red ✗ appears on the last commit in GitHub immediately before the assignment's due date.

Learning

If you have not done so already, please read all of the relevant GitHub Guides that explain how to use many of the features that GitHub provides. In particular, please make sure that you have read the following GitHub guides: Mastering Markdown, Hello World, and Documenting Your Projects on GitHub. Each of these guides will help you to understand how to use both GitHub and GitHub Classroom.

To do well on this assignment, you should also review all of the chapters in the text book, including those that we will cover during the rest of the semester. Please see the course instructor or one of the teaching assistants or tutors if you have questions about any of these reading assignments.

Commands

To get started in using the GatorGrader tool, you can change into the directory for this assignment and type the command gradle grade in your terminal. Running this command will produce a lot of output that you should carefully inspect. If the output indicates that GatorGrader judges that there are no mistakes in the assignment, then this means that your source code and writing are passing all of the automated baseline checks. However, if the output indicates that there are mistakes, then you will need to understand what they are and then try to fix them.

You can also complete several important Java programming tasks by using the gradle tool. For instance, you can compile (i.e., create bytecode from the program's source code if it is a correct program) the program using the command gradle build. There are also additional commands that you can type:

• gradle clean: clean the project of all the derived files
• gradle check: check the quality of the code using Checkstyle
• gradle build: create the bytecode from the Java source code
• gradle run: run the Java program in the command-line
• gradle tasks: display details about the Gradle system

To run one of these commands, you must be in the main directory for this assignment where the build.gradle file is located. Then, you can type the command in the terminal and study the output. Please note that, if your program interacts with the user in the terminal window, you must run it differently than you ran past programs. In this situation, you would type the following command in your terminal window:

gradle -q --console plain run

Checks

In addition to meeting all of the requirements outlined in the assignment sheet, your submission must pass the following checks:

• writing/proposal.md:

  • Passes the checks performed by the Markdown linting tool
  • Passes the checks performed by the Proselint linting tool
  • Contains exactly five uses of a ## fragment
  • Contains exactly four contiguous paragraphs of formatted text
  • Each contiguous paragraph contains at least 50 words

• writing/reflection.md:

  • Passes the checks performed by the Markdown linting tool
  • Passes the checks performed by the Proselint linting tool
  • Contains exactly three uses of a ## fragment
  • Contains exactly three contiguous paragraphs of formatted text
  • Each contiguous paragraph contains at least 100 words

• writing/report.md:

  • Passes the checks performed by the Markdown linting tool
  • Passes the checks performed by the Proselint linting tool
  • Contains exactly three uses of a ## fragment
  • Contains exactly three contiguous paragraphs of formatted text
  • Each contiguous paragraph contains at least 100 words

• writing/update.md:

  • Passes the checks performed by the Markdown linting tool
  • Passes the checks performed by the Proselint linting tool
  • Contains exactly two uses of a ## fragment
  • Contains exactly two contiguous paragraphs of formatted text
  • Each contiguous paragraph contains at least 100 words

• GitHub repository:

  • Contains at least ten commits beyond the repository's starting number of commits

Updates

If the course instructor updates the provided material for this assignment and you would like to receive these updates, then you can type this command in the main directory for this assignment:

git remote add download git@github.com:Allegheny-Computer-Science-101-F2018/cs101-F2018-lab10-starter.git

You should only need to type this command once; typing the command additional times may yield an error message but will not negatively influence the state of your repository. Now, you are ready to download the updates provided by the course instructor by typing:

git pull download master

This second command can be run whenever the course instructor needs to provide you with new source code for this assignment. However, please note that, if you have edited the files that the course instructor updated, running the previous command may lead to Git merge conflicts. If this happens, you may need to manually resolve them with the help of the instructor or a teaching assistant.

Travis

This assignment uses Travis CI to automatically run the checking programs every time you commit to your GitHub repository. The checking will start as soon as you have accepted the assignment, thus creating your own private repository, and the course instructor enables Travis for it. If you are using Travis for the first time, you will need to authorize Travis CI to access the private repositories that you created on GitHub.

Requirements

The GatorGrader software that supports the checking of this assignment was developed for the following software and versions:

• Gradle 4.6
• Java 1.8.0
• MDL 0.4.0
• Proselint 0.8.0
• Python 3.6

Problems

If you have found a problem with this assignment's provided source code, then you can go to the Computer Science 101 Lab 10 Starter repository and create an issue by clicking the "Issues" tab and then clicking the green "New Issue" button. If you have found a problem with the GatorGrader tool and the way that it checks you assignment, then you can follow the aforementioned steps to create an issue in its repository. To ensure that your issue is properly resolved, please provide as many details as is possible about the problem that you experienced. If you discover a problem with the laboratory assignment sheet, then please raise an issue in the cs101-F2018-sheets repository and mention this assignment.

Students who find, and use the appropriate GitHub issue tracker to correctly document, a mistake in any aspect of this laboratory assignment will receive free laptop stickers and extra credit towards their grade for it.

Assistance

If you are having trouble completing any part of this project, then please talk with either the course instructor or a teaching assistant during the laboratory session. Alternatively, you may ask questions in the Slack workspace for this course. Finally, you can schedule a meeting during the course instructor's office hours.