README.md: Add contributing/running tests section

[msabramo]

with links to:

• test/README.md
• test/functional/README.md

because I was looking for info on how to run tests in the main README.md and didn't find it and I only found about these other docs when @willdurand kindly pointed them out to me in #194 (comment)

[willdurand]

Weird that the test suite fails for such a change..

👍 otherwise

[msabramo]

Yeah, test failure looks spurious and unrelated to my change.

Can an admin please tell Travis to retest?

[dmp42]

Restarted. You should be able to trigger a rebuild by just git push -f it.

[dmp42]

LGTM otherwise! Nice to see interest in these.

[dmp42]

What about a CONTRIBUTING.md document where these (and other dev infos) would be put, instead of into the general README doc?

[willdurand]

Agreed on a CONTRIBUTING file. Any template that you would like to use? I use this in most of my projects, and it should be easy to adapt it for this project.

[msabramo]

OK, I moved the testing info from README.md to CONTRIBUTING.md (and put a link in README.md to CONTRIBUTING.md.

I'll leave it to someone more experienced to:

• Document the canonical way to run the tests - I'm getting a lot of failures, so I'm not sure I'm doing stuff right.
• Document what the standards are for coding, commit messages, etc.

[willdurand]

To me, it is really important to add:

Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.

You MUST run the test suite.

You MUST write (or update) unit tests.

You SHOULD write documentation.

Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.

One may ask you to squash your commits too. This is used to "clean" your Pull Request before merging it (we don't want commits such as "fix tests", "fix 2", "fix 3", etc.).

Also, while creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you are creating it.

Thank you!

[dmp42]

+1 on @willdurand suggestion

[msabramo]

Implemented @willdurand's suggestion.

See: https://github.com/msabramo/hipache/blob/patch-4/CONTRIBUTING.md

[Starefossen]

LGTM

[dmp42]

Merged then :)

[willdurand]

youpi!