Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (50 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 2.36 KB

Contributing to gcorelabscloud-go

We love your input! We want to make contributing to gcorelabscloud-go 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

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept 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. Make sure your code follows the existing style
  5. Issue that pull request!

Development Setup

  1. Install Go 1.21 or later
  2. Clone the repository: 
    git clone https://github.com/G-Core/gcorelabscloud-go.git
cd gcorelabscloud-go
  3. Install dependencies: 
    go mod download

Code Style

  • Follow standard Go conventions and Effective Go
  • Include comments on exported functions and types

Testing

  • Add tests for any new code you write
  • Tests should be clear and maintainable

Pull Request Process

  1. Update the README.md with details of changes to the interface, if applicable
  2. Update any relevant documentation
  3. The PR will be merged once you have the sign-off of at least one maintainer

Any contributions you make will be under the Mozilla Public License Version 2.0

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

License

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