Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 3.69 KB
Raw

Contributing to top-issues-action

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, track issues and feature requests, and 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. Create a new feature branch to implement your changes on.
  3. Add tests if you've added code that should be tested.
  4. If you've changed the internal working of the repository, update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code lints.
  7. Issue that pull request!

Keep your fork updated

As the README explains, this repository uses GitHub actions to create several derivative databases from the main databases. By default, the create_db_derivatives.yaml action that makes these derivative databases is disabled on forks. You therefore have to follow the following steps if you want this action to automatically generate the correct derivative databases on your fork:

  1. Set the CREATE_DERIVATIVES repository variable to true in your repository settings (see the GitHub documentation).
  2. Change the default GITHUB_TOKEN permissions to Read and write permission (see the GitHub documentation).

Report bugs using Github's issues

This is an example of a bug report, and I think it's a good model. Here's another example from Craig Hockenberry, an app developer greatly respected in the community.

Write bug reports with detail, background, and sample code

This is an example of a bug report, and I think it's a good model. Here's another example from Craig Hockenberry, an app developer greatly respected in the community.

Great Bug Reports tend to have:

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

We use black formatter to format our python code. You are advised to use flake8 for linting your code.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.