Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.93 KB
Raw

Contributing to Dumpus

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

Developing

Checkout DEVELOPERS.md

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main using git checkout -b <branch-name>
  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 using pnpm lint
  6. Issue that pull request!

Any contributions you make will be under the GNU GPLv3 Software License

In short, when you submit code changes, your submissions are understood to be under the same GNU GPLv3 License that covers the project. Feel free to contact the maintainers if that's a concern.

To contribute, you'll have to agree to our CLA (Contributor License Agreement).

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, and I think it's not a bad model. Here's another example from Craig Hockenberry, a great app developer.

Great Bug Reports tend to have:

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

  • Make sure you code with Visual Studio Code and the Prettier extension. It will pick up the repo's config. Otherwise, run pnpm format.
  • You can try running pnpm lint for style unification

License

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

References

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