Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 2.22 KB
Raw

Contributing to CloudBerry Support Tools

We love your input! We want to make contributing to CloudBerry Support Tools 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.

Pull Requests Process

  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 follows the existing style.
  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 [issue tracker]

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

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)

For core file analysis issues, please include:

  • The command line used
  • Relevant sections of the analysis output
  • CloudBerry Database version
  • Python version
  • GDB version

Coding Style

  • Python code follows PEP 8
  • Use type hints where possible
  • Include docstrings for functions and classes
  • Comments should explain why, not what
  • Keep functions focused and reasonable in length

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.