Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.74 KB

Contributing to ytnoti

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

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

Table of Contents

How to Contribute to the codebase

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!

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 that I think is not a bad model.

Great Bug Reports tend to have:

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

Follow PEP 8 Guidelines, which are standard coding style guidelines for Python

  • You can try running pylint for style unification

If you have any questions, please don't hesitate to ask. You can contact me via Discord or email: contact@seoulsky.org.

License

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

Code of Conduct

Consider reading Code of Conduct.