Skip to content

Latest commit

 

History

History
137 lines (97 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

137 lines (97 loc) · 4.51 KB

Contributing to GoDS library

Your input is always welcome! I 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

Developed with Github

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

I Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (I use Github Flow).

Before you start, make sure you have installed pre-commit on your development machine. To install pre-commit, run the following command:

On most OSes:

pip install pre-commit

On some Linux distributions (like for example OpenSUSE), you may need to install pre-commit using the following command:

sudo zypper install python311-pre-commit

To have pre-commit available system wide.

Please Note: zypper is the package manager for OpenSUSE. You may need to use a different package manager depending on your Linux distribution.

On the Mac, you can install pre-commit using Homebrew:

brew install pre-commit

Once you have pre-commit installed, fork GoDS and clone it to your development machine. Then, in the root directory of the repository of the project, run the following command to install the pre-commit hooks:

pre-commit install

This will install the pre-commit hooks and will run them on every commit you make. If any of the hooks fail, the commit will fail and you'll have to fix the issues before you can commit.

Last bit I recommend is to test you have all pre-commit hooks dependencies installed. To check this, run the following command:

pre-commit run --all-files

If you have all the dependencies installed, everything should pass. If not, you'll see a list of errors and warnings. You can install the dependencies by following the instructions in the error messages.

Your pull requests are always welcome. When you send a pull request, please:

  1. Fork the repo and create your branch from our develop branch.
  2. If you've added code that should be tested, add tests. For more information on testing, see Test Policy for GoDS.
  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 Apache 2.0 Software License

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

Report bugs using Github's issues

This project uses 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.

Use a Consistent Coding Style

  • Format rules followed are the same as the ones used by the Go community
  • Format rules are enforced by pre-commit gofmt hook
  • For what concern function definitions, if your function can fail, it should return an error as the last return value. For more information, see Error Handling and Go
  • Ensure you have added or updated unit tests to cover your changes. For more information, see Test Policy for GoDS.
  • Ensure you comment your code, packages and functions according to the rules described in Effective Go

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone.

License

By contributing, you agree that your contributions will be licensed under its Apache 2.0 License.

References

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