-
Notifications
You must be signed in to change notification settings - Fork 1
GIT help
- The GIT book. A community developed book, which is very good.
- Github help pages are good for both github specifics and general GIT help.
- GIT video tutorials
- Intro to GIT in Norwegian (with special focus on setting it up on the University of Oslo)
- GIT Reference
Run git clean -fdx to clean all files not tracked by GIT. Use git clean -ndx for a dry-run (nothing is removed). This is very useful after moving code around, since we ignore .pyc-files, and they get left behind when moving files (causing issues when they are loaded instead of the .py-file which is at another location).
To make it easy to view the history log, format your commit messages according to these rules:
(where) (short description)
(long description)
An example message for changes made to apps/examiner/simplified.py could look like this for Python modules:
apps.examiner.simplified: Added a Subject class
Added a Subject class that examiners can use to fetch information
about all the subjects he/she is an examiner for.
And like this for docs (in the docs/ directory):
docs: devilry.examiner.simplified: Documented the API
Added usage examples and API documentation for all simplified classes.
If changes are made to multiple files, try to keep the commits within the same topic, and use that topic in place of the file-name. Say you made changes to simplified.py and added tests for them in the same commit. The message could look like this:
apps.examiner.simplified: Added an Assignment class and tests for it
Created an Assignment class so examiners can fetch information about the
assignments he/she is assigned.
Added tests for the new class