Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A basic template for contributing guidelines that I adapted from Facebook's open source guidelines

Contributing to Transcriptase

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

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

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My 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 Facebook's Guidelines

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint 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

@uzaymacar
Copy link

uzaymacar commented Jul 3, 2019

Looks great!

@generic-github-user
Copy link

generic-github-user commented Aug 14, 2019

Thanks, this is very useful!

@sfmskywalker
Copy link

sfmskywalker commented Mar 28, 2020

Still very useful to this date! Thanks!

@michael-kotliar
Copy link

michael-kotliar commented Jul 12, 2020

Thanks!

@Xkonti
Copy link

Xkonti commented Aug 18, 2020

There's a passive voice used in:

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.

It would be preferable to use the active voice:

In short, when you submit code changes, your submissions will be understood under the same MIT License that covers the project.

Thanks for a great template!

@chrisreddington
Copy link

chrisreddington commented Dec 6, 2020

This is great, I will be using this as a basis - Thank you!

@alexkasongo
Copy link

alexkasongo commented Jan 6, 2021

Amazing!

@UltiRequiem
Copy link

UltiRequiem commented Jan 24, 2021

thanks

@kurtseifried
Copy link

kurtseifried commented Feb 2, 2022

@markus-codechefs
Copy link

markus-codechefs commented Mar 22, 2022

Thanks as well. I'm gonna use this as a template.

@VeldaKiara
Copy link

VeldaKiara commented May 23, 2022

Thank you for this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment