Contributing to Hydrant

Hydrant is a relatively young project that can use plenty of help from anyone. Things listed here are rough guidelines, but are a good starting direction.

If you have any questions, feel free to email jeff at jeffhui.net with some subject talking about Hydrant.

Filing Bugs

Found a bug? File an issue on the GitHub page. When you write on up, be sure to include:

  • Steps to reproduce the behavior in question. Small code examples that demonstrate is are excellent!
  • Expected behavior, what expected to happen.
  • Actual behavior, what actually happened.

These points are mostly a starting conversation about the issue.

Contributing Code

Code is welcomed, although unlike application code, is subjected to more scrutiny. Since the most expense part about software is maintaince, so pull requests require the following:

  • Tests that can verify the regression (if a bug) or validate a new feature
  • If its a new feature, documentation explaining the new feature.

It’s good to keep in mind the original design of Hydrant when writing the code.

Feedback about the pull request or code contributes are never towards the contributor, but instead towards improving the code.

Read the Docs v: latest
Versions
latest
stable
v2.0.0
v1.1.0
v1.0.1
v1.0.0
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.