Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

70 lines (46 loc) · 2.56 KB
Raw

Contributing to hata repository

We would love your input! This open source repository is open to new ideas and improvements from anyone.

When contributing to this repository, please first discuss the change you wish to make via issues, discussions or via chat in our Discord server.

Note that contributions may not be accepted immediately on the basis of a contributor failing to follow these guidelines.

Your code changes should happen through pull requests

We actively welcome your pull requests:

  1. No force-pushes or modifying the Git history in any way.

  2. If PRing from your own fork, ensure that "Allow edits from maintainers" is checked. This gives permission for maintainers to commit changes directly to your fork, speeding up the review process.

  3. Adhere to the prevailing code style

    We do not use flake8, or other predefined styles, but please try to stick yourself to the currently used one.

    Some minor things you might notice:

    • Codebase uses single quotes ' for strings.
    • The preferred line length is 120 characters.
    • Descriptive names are preferred even if they are longer.
    • Docstrings are numpy-like, but unique to hata.

Report bugs using GitHub's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue

When creating a new issue, please follow our templates if possible.

In general Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
  • 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.

Discuss features using GitHub's discussions

Have a new idea? Want to discuss existing one? Please open an issue, or use discussions

When opening discussion make sure you go into details and give as much info as you can.

For example:

  • A quick summary (what's it for, what would it do)
  • Reason for having this
  • Approximate things that would need to be added/changed (if lot make a todo list)
  • Possibly some short example code

Changes to this Arrangement

All projects evolve over time, and this contribution guide is no different. This document is open to pull requests or changes by contributors. If you believe you have something valuable to add or change, please don't hesitate to do so in a PR.

Footnotes

This file was inspired by