Skip to content
This repository was archived by the owner on Nov 16, 2022. It is now read-only.

Latest commit

 

History

History
60 lines (39 loc) · 2.74 KB

CONTRIBUTING_GUIDELINES.md

File metadata and controls

60 lines (39 loc) · 2.74 KB

Contributing to Politicry

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 master.
  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

Here's an example from Craig Hockenberry on how to write an excellent bug report. It's important that a bug report contains information on what you were doing when the bug was found, what you expected the behavior, what the behavior was, any details/other information you're able to provide. Ideally, if you're able to provide sample code that triggers the bug that would be very helpful.

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)

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

Use a Consistent Coding Style

I'm borrowing these from Facebook's Guidelines

  • tabs for indentation
  • You can run the pre-commit hooks via pre-commit run --all-files which should catch most linting failures

References

This document was modified slightly from the open-source contribution guidelines for Transcriptase