From aefbc0d199ad833de5354a6f2881ad7015083adc Mon Sep 17 00:00:00 2001 From: William Ball <33137947+Althoumb@users.noreply.github.com> Date: Wed, 4 Apr 2018 12:45:33 -0700 Subject: [PATCH] Create contribution guidelines --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dc8752a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +## Guidelines for contributing + +Please follow [Java coding standards](http://www2.hawaii.edu/~tp_200/ics111/material/codingStandards.html) and comment often, so everyone else can understand what your code does. + +Every class and method should be preceded with a descriptive comment using Javadoc notational convention. + +Please compile and run your code at least once before pushing to a main branch like master or develop. +If the code won't run, save your changes to a personal branch instead on a branch others rely on.