Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 2.64 KB
Raw

Contributing to DeepLynx

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/GitLab

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

We Use GitLab/GitHub, So All Code Changes Happen Through Pull Requests or Merge Requests

Pull/Merge 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 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/merge 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 or GitLab issues to track public bugs.

Write bug reports with detail, background, and sample code

This is an example of a bug report. Here's another example from Craig Hockenberry.

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)

Use a Consistent Coding Style

Please ensure that you use ESLint, with the including configuration, when contributing to the project. Please maintain naming schemes and structure throughout the project.

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 This Contribution Guideline was adapted from GitHub user briandk.