Skip to content

Commit

Permalink
Merge branch 'musselwhizzle/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
rderimay authored and rderimay committed Jan 8, 2017
2 parents 1eb0cbd + 1c29895 commit 08ceb3b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,9 @@ Thank you for considering to contribute to the project. To make things go smooth
2. All Pull Requests must have an Issue and focus on a single task. Pull Requests which are not targeted to a single task and change multiple isolated Issues will not be accepted.
3. Follow the naming convention that's already in place such as helloWorld and not hello_world.
4. All functions must have "javadoc" style documents that go along with it. Write a short description what the function does, what params it takes, and the possible return values. If a return is a table, list what properties the table can have.
5. Do not refactor code just because. If something needs refactored, file an Issue and get approval.
5. Do not refactor code just because. If something needs refactored, file an Issue and get approval.


Using Git - A typical workflow
=======
When you begin work on a new Issue, create a branch for this based off of master. "git checkout -b my_issue". "git push -u origin my_issue". Make all of your changes here in this branch. When it comes time put these changes into the master repo, make sure your master is up to date. "git checkout master". "git fetch". "git pull". If there are changes in master, you'll need to merge those into your branch. "git checkout my_issue". "git merge master". If there are conflicts, those will need to be resolve "git mergetool". Resolve the conflicts and "git commit". You're now ready to make a Pull Request from your branch into master.

0 comments on commit 08ceb3b

Please sign in to comment.