Designed for use with GitHub Classroom, this repository contains the starter for Lab 5 in Computer Science 203. 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.
This assignment requires a programmer to implement, document, and automatically
test a Python program called
GatorGrouper. This repository
should contain the conduct.md, assessment.md, and report.md files that
respectively contain a statement indicating that you adhered to the code of
conduct, an assessment of the work that you completed this week for the
long-term software project, and a report that further documents your work. To
create the first version of the conduct.md and the assessment.md files you
can copy these files from the Code of
Conduct
and Assessment
Guide
repositories that you populated as part of a previous laboratory assignment.
Importantly, the purpose of this repository is only to document and evaluate the
work that you complete in the
GatorGrouper repository.
Students who do not understand how to copy-over or fill-in these files should
speak with the course instructor. Please refer to the report.md file for
additional details about how to report on and evaluate your work.
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.
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. Specifically, the mistakes for the files in this
repository will related to the fact that they may not exist or that they do not
pass the linting checks of the two linters.
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-203-S2019/cs203-S2019-lab5-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.
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.
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
If you have found a problem with this assignment's provided source code, then you can go to the Computer Science 203 Lab 2 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 cs203-S2019-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 GitHub stickers and extra credit towards their grade for it.
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.