Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

57 lines (41 loc) · 2.46 KB
Raw

Contributing to Netfetch

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 actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  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 license we use

In short, when you submit code changes, your submissions are understood to be under the same 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

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.

Commit Messages and Semantic Versioning

For versioning, we follow Semantic Versioning. Please include one of the following in your commit messages to indicate the type of release:

  • #major for major changes
  • #minor for minor features and enhancements
  • #patch for bug fixes and patches

This is required for the automatic versioning script and omitting this will result in a failed merge.

License

By contributing, you agree that your contributions will be licensed under its LICENSE.

References

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