Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 4.27 KB

CONTRIBUTING.md

File metadata and controls

75 lines (56 loc) · 4.27 KB

Contributing to Video-To-Gif

We love your input! We 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. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. 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

This is an example of a bug report Some good programmer wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. Some stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • 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)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

I'm again borrowing these from Python Black (https://github.com/psf/black)

  • 4 spaces for indentation rather than tabs
  • All leading tabs are converted to spaces, but tabs inside text are preserved.
  • Whitespace leading and trailing one-line docstrings is removed.
  • You can try running black {source_file_or_directory} or
python -m black {source_file_or_directory} # you can write ./ for all files in the dir

for style unification

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

And the basic guide by briandk/CONTRIBUTING.md The link to the file

Code of Conduct

We are committed to creating a welcoming and inclusive environment for all contributors to Video-T0-Gif. This includes not only the code, but also the documentation, issues, and pull requests. To that end, we have adopted the following code of conduct:

  • Be respectful and professional in all interactions. This includes using inclusive language and avoiding discriminatory or offensive comments.
  • Follow the Style Guide for coding and documentation.
  • Document your code and include clear instructions for how to use it.
  • Provide accurate and up-to-date documentation for any new features or changes.
  • Be responsive to feedback on your documentation and make updates as necessary.
  • We will not tolerate any form of harassment or discrimination. If you experience or witness any violation of this code of conduct, please report it to the project maintainers.

We appreciate your contributions and look forward to working with you 👍.