Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.86 KB

Contributing to Gortb

Thank you for your interest in contributing to Gortb! This document provides guidelines and information for contributing to this OpenRTB 2.5 implementation in Go.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/gortb.git
  3. Create a new branch for your changes: git checkout -b feature/your-feature-name

Development Guidelines

Code Style

  • Follow standard Go coding conventions and idioms
  • Use gofmt to format your code
  • Add comments for exported functions and types
  • Write descriptive variable and function names
  • Keep functions focused and concise

Testing

  • Write unit tests for new functionality
  • Ensure all tests pass before submitting a PR
  • Aim for high test coverage
  • Use table-driven tests where appropriate

Documentation

  • Update documentation for any new or modified functionality
  • Include examples in godoc comments
  • Keep the README.md up to date

Pull Request Process

  1. Update tests and documentation
  2. Run all tests locally
  3. Ensure your code follows the project's style
  4. Create a Pull Request with a clear title and description
  5. Link any relevant issues
  6. Wait for review and address any feedback

Testing

To run the tests:

go test ./...

Reporting Issues

  • Use the GitHub issue tracker
  • Include clear steps to reproduce bugs
  • Provide version information
  • Include relevant code samples

OpenRTB 2.5 Compliance

  • Ensure all changes comply with the OpenRTB 2.5 specification
  • Reference the relevant section of the spec in comments
  • Maintain backward compatibility where possible

License

By contributing to Gortb, you agree that your contributions will be licensed under the project's license.

Questions?

Feel free to open an issue for any questions about contributing to the project.

Thank you for helping improve Gortb!