Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 3.05 KB

Contributing to Indeplot

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 anything, please update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!
  7. Make all your PRs with the develop branch
  8. Create a pull request to the develop branch and your pull request title must contain [dev] keyword and your work short title

Any contributions you make will be under the GNU GENERAL PUBLIC LICENSE v3

In short, when you submit code changes, your submissions are understood to be under the same GNU GENERAL PUBLIC LICENSE v3 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 , and We think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.But again this is an example you can follow your own.

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 again borrowing these from Facebook's Guidelines

  • Maintain proper indentation using tabs
  • Here is is shortcut CTRL+Shift + I (for VS Code users) . It will auto indent your code.

License

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

References

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