Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

58 lines (44 loc) · 3.08 KB
Raw

Contributing to HydDowm

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

  • Reporting a bug
  • Support/questions
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

When contributing to this repository, please first discuss the change you wish to make via filling an issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Support

For questions, assistance using the code or special considerations please file an issues and add the label 'question' or 'help wanted'

We Develop with Github

HydDown uses github to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repository from 'main' to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Commit changes to the branch
  5. Push changes to your fork
  6. If you've added code that should be tested, add tests.
  7. If you've changed APIs added functionality, update the documentation.
  8. Ensure the test suite passes (handled by github action).
  9. Make sure your code lints (handled by github action).
  10. Open a PR in our repository

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy! Add the label 'bug' to the filed issue - which may be removed by the maintainer if this is actually not a bug, but e.g. enhancement/feature request.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft as well as from Auth0 and briandk