Hi! I'm really excited that you are interested in contributing to Hippy. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
- Code of Conduct
- Issue Reporting Guidelines
- Pull Request Guidelines
- Development Setup
- Project Structure
- Always use Bug Report or Feature Request to create new issues.
-
Setting up your local environment to get started. You will need have git and npm installed locally, then run
npm install
to download all needed dependencies. These are detailed in the Development Setup guide. -
Checkout a topic branch from the relevant branch, e.g.
master
, and merge back against that branch. -
Test cases have been added/updated/passed for the code you will submit.
-
Documentation has added or updated.
-
Commit message is following the Convention Commit guideline with maximum 72 characters.
-
Squash the repeat code commits, short patches are welcome.