Skip to content

Latest commit

 

History

History
71 lines (53 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

71 lines (53 loc) · 2.89 KB
Raw

Contributing to Hanime

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

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

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Make sure your code is bug free.
  4. Issue that pull request!

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. Feel free to contact the maintainers if that's a concern.

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!

Write bug reports with detail, background, and sample code

Here is the example:

Describe the bug

A clear and concise description of what the bug is.

To Reproduce

Expected behavior

A clear and concise description of what you expected to happen.

Priority

What is the impact of this bug on the user, how critical is to fix? P0, P1 .. P4 Reference - Google Issue tracker priority levels

Screenshots/Video

If applicable, add screenshots/video to help explain your problem. Remember to mark the area in the application thats impacted.

Desktop

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari, firefox, edge]
  • Resolution [e.g. 2560 X 1289]
  • Version [e.g. 22]

Mobile/Tablet

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Screen size: [e.g. 4.75, 5.5]
  • Mobile Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context

Add any other context about the problem here.

Use a Consistent Coding Style

I'm borrowing these from Facebook's Guidelines

  • tabs for indentation rather than spaces ( i'm a tab person )

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