Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 2.58 KB

Contributing to OCP-SRV-CMS-Benchmarks

We're thrilled that you're interested in contributing to OCP-SRV-CMS-Benchmarks! This document provides guidelines for contributing to the project. By participating in this project, you agree to abide by its terms.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Reporting Bugs
  5. Suggesting Enhancements
  6. Pull Requests
  7. Style Guidelines
  8. Community

Code of Conduct

This project and everyone participating in it is governed by the OCP-SRV-CMS-Benchmarks Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

  • Make sure you have a GitHub account
  • Fork the repository on GitHub
  • Clone your fork locally
  • Set up the development environment as described in the README.md

How to Contribute

There are many ways to contribute to OCP-SRV-CMS-Benchmarks:

  1. Implement new benchmarks
  2. Improve existing benchmarks
  3. Add or update documentation
  4. Report bugs
  5. Suggest enhancements
  6. Help with code reviews

Reporting Bugs

  • Use the GitHub Issues page to report bugs
  • Before creating a new issue, please check if the bug has already been reported
  • Be as detailed as possible in your report. Include:
    • Your operating system name and version
    • Any details about your local setup that might be helpful in troubleshooting
    • Detailed steps to reproduce the bug

Suggesting Enhancements

  • Use the GitHub Issues page to suggest enhancements
  • Provide a clear and detailed explanation of the feature you want to see
  • Provide code snippets and use cases demonstrating the new feature, if applicable

Pull Requests

  1. Create a new branch from main for your changes
  2. Make your changes in your branch
  3. Add or update tests as necessary
  4. Ensure the test suite passes
  5. Make sure your code lints
  6. Issue a pull request with a comprehensive description of changes

Style Guidelines

  • Follow the coding style used throughout the project
  • Write clear, readable, and maintainable code
  • Comment your code where necessary
  • Update documentation as needed

Community

  • Participate in code reviews
  • Help answer questions on the issue tracker
  • Attend community events (if any)

Thank you for contributing to OCP-SRV-CMS-Benchmarks!