Skip to content

Latest commit

 

History

History
75 lines (44 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

75 lines (44 loc) · 2.28 KB

Contributing to the Postman to OpenAPI Converter

Welcome!! 🎉

Thank you for your interest in contributing to the Postman to OpenAPI Converter.

This project aims to help developers and API designers streamline their workflows, converting Postman collections to OpenAPI specs more efficiently.

This document will guide you through the steps to contribute.

Ground rules

In the spirit of collaboration, we aim to foster an open and respectful environment:

  • Openness 👐: Everyone is encouraged to share their ideas.
  • Respect 🙌: Valuing all contributions and perspectives.
  • Clarity ✍️: Please keep communication straightforward to help everyone stay on the same page.

Getting started

Follow the steps below on how you can contribute:

  1. Fork the repository

    Click the Fork button at the top right of the repository page to create a copy in your account.

  2. Create a branch

    Set up a feature branch locally for your changes:

    git checkout -b feature/AmazingFeature
  3. Make your changes

    Implement your changes locally, keeping commits focused on the specific feature or fix.

    If you want ideas on what to contribute, you can check our list of issues. We're sure you'll find something interesting.

  4. Test your code

    Run tests to ensure your code works as expected and doesn’t introduce any issues.

    This project uses npm for dependency management, so be sure to install dependencies with:

    npm install

    Then you can view your changes using the command below:

    npm run dev
  5. Commit and push

    Write clear, descriptive commit messages to document your changes:

    git commit -m "feat: add AmazingFeature"
    git push origin feature/AmazingFeature
  6. Submit a pull request

    Open a pull request (PR) to the main branch of the project repository.

    In the PR, provide a brief description of your changes and reference any related issues.

Review process

Once submitted, the maintainers will review your pull request. Feedback may include suggested changes to align with project standards.

Once everything looks good, your PR will be merged!