For Contributors

When you visit this page, the community knows you want to be a part of it. There are so many things any developing community has to improve, we're sure you'll find something of interest to join us.

We have gathered wisdom elsewhere from the internet as the guidelines for this community to thrive.

Issues

If you experienced something wrong, open an issue:

• give the context
• explain what you want to do
• provide steps to reproduce
• note your expectation

New features

If you find something missing that make sense for you and many other people

• open an issue
• explain what you need and why you need
• keep content concise and clear

Pull requests

If you find an issue that you are ready to work on

• propose your solutions within the issue
• collect feedbacks from community
• revise your solutions
• repeat the feedbacks/revises process until it's ready to implement
• note community that you are working on (without doing this, someone else may be doing the same thing)
• implement your solution, unit tests are absolutely required

Discussions

• Keep discussion public and transparent via issues
• Respect decisions from community

Step for contributors to work on pull requests

Visit https://github.com/h1st-ai/h1st and follow this instruction to folk to your account

git clone https://github.com/your-github-id/h1st

cd h1st
git checkout -b your-feature-branch-name
git push -u origin your-feature-branch-name
virtualenv -p python3 venv
source venv/bin/activate
pip install -e .

work on your implementation

nose2 #make sure all unit tests passed before pushing