Document pre-commit hooks

[timokau]

Description

Finishing up #78 and #100 with some documentation.

Motivation and Context

New contributors should apply the pre-commit hooks and understand what they are doing.

How Has This Been Tested?

--

Does this close/impact existing issues?

#78, #100

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.

[coveralls]

Pull Request Test Coverage Report for Build 744

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-9.05%) to 49.786%

---

Totals
Change from base Build 743:	-9.05%
Covered Lines:	3719
Relevant Lines:	7470

---

💛 - Coveralls

[coveralls]

Pull Request Test Coverage Report for Build 744

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 676 unchanged lines in 20 files lost coverage.
• Overall coverage decreased (-18.4%) to 40.428%

---

Files with Coverage Reduction	New Missed Lines	%
csrank/tests/test_ranking.py	1	98.33%
csrank/dataset_reader/discretechoice/util.py	2	12.07%
csrank/numpy_util.py	4	65.79%
csrank/theano_util.py	4	40.74%
csrank/discretechoice/discrete_choice.py	5	41.18%
csrank/discretechoice/fatelinear_discrete_choice.py	8	60.0%
csrank/discretechoice/fetalinear_discrete_choice.py	8	60.0%
csrank/metrics_np.py	12	72.95%
csrank/discretechoice/pairwise_discrete_choice.py	15	46.43%
csrank/discretechoice/cmpnet_discrete_choice.py	16	44.74%

Totals
Change from base Build 743:	-18.4%
Covered Lines:	3020
Relevant Lines:	7470

---

💛 - Coveralls

[kiudee]

Very clear and consise description. 👍