Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (44 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 2.87 KB

CONTRIBUTING.md

Welcome to the OpenAPI Mocker Contributing Guide!

Thank you for your interest in contributing to the OpenAPI Mocker project! We're glad you're here. This document provides guidelines for making contributions to the project. Whether you're looking to submit a bug report, propose new features, or contribute code, your help is very much appreciated.

How to Contribute

Reporting Bugs

Bugs are tracked as GitHub issues. To report a bug, create an issue and include:

  • A clear title and description.
  • Steps to reproduce.
  • Expected behavior.
  • Actual behavior.
  • Screenshots if applicable.

Suggesting Enhancements

We love to receive suggestions for improvements! If you have ideas to make OpenAPI Mocker better, please submit an issue with the following:

  • A clear title and description.
  • Explain why this enhancement would be useful to most OpenAPI Mocker users.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through the 'beginner' and 'help-wanted' issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Both issue lists are great places to start and are specifically tagged to indicate that help is needed.

Pull Requests

Here’s how to submit a pull request:

  1. Fork the repo and create your branch from main.
  2. Clone the repository to your local machine.
  3. Make your changes and ensure your code adheres to the existing style to keep the code consistent.
  4. If you've added code, add tests!
  5. Ensure your code passes all the tests.
  6. Issue that pull request!

Include a clear description of the reasons for your changes. It should include relevant motivations and context. List any dependencies that are required for this change.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Code Style for rust

  • Follow the Rust style guide for Rust code.
  • Ensure you run lint checks before submitting your pull request.

Community

  • If you have any questions about how to interpret the guidelines or want to discuss a substantial change/idea, don’t hesitate to post on our community channels or directly on GitHub issues.

Thank You!

Every contribution counts, and by participating, you are expected to uphold this code. We appreciate your effort, and are excited to welcome you aboard and see what you can bring to the project!

Let's create something amazing together!