Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.09 KB

Contributing to Hangle

Please read the PRIORITY LIST before contributing.

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting an issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Our Development Process

All changes happen through pull requests. Pull requests are the best way to propose changes. We actively welcome your pull requests and invite you to submit pull requests directly here, and after review, these can be merged into the project.

Using the Project's Standard Commit Messages

This project is using the conventional commits standard. Please follow these steps to ensure your commit messages are standardized:

  1. Make sure your shell path is in the root of the project (not inside any of the packages).
  2. Run yarn.
  3. Stage the files you are committing with git add [files].
  4. make a commit with git commit -m "message here"
  5. once you are done you can push your changes

Pull Requests

  1. Fork the repo and create your branch (usually named patch-%the number of PRs you've already made%) from staging.
  2. Ensure to describe your pull request.

Issues

NOTE: If your bug is a security vulnerability, please instead see the security policy

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. Report a bug by opening a new issue; it's that easy!

Feature Request

Great Feature Requests tend to have:

  • A quick idea summary.
  • What & why you wanted to add the specific feature.
  • Additional context like images, links to resources to implement the feature etc, etc.

License

By contributing to DogeHouse, you agree that your contributions will be licensed under the LICENSE file.