CONTRIBUTING.md

We’re thrilled you want to contribute to OpenAPI AutoSpec!

If you have any feedback or ideas for improvement, please open an issue and let's discuss it.

How can you help?

Tell us ideas, any bugs, or ways to make the tool easier to use. Talk about OpenAPI AutoSpec in Slacks, Discords, or any local meetups where there is mutual hatred of manually documenting endpoints without any tools to help. If there is a direct bug or feature that you think is an easy writeup please bring it our way in a PR.

Local development

Our repo is a monorepo that you can clone or fork.

Step one: Fork this repo

Fork by clicking on this link

Step two: Clone your fork and open in your preferred IDE

git clone <your fork>
cd openapi-autospec
code .

Step 3: Install dependencies

Npm install

git clone <your fork>
cd openapi-autospec
code .

Committing Your Work

Ready to save your progress? Commit your changes to your branch.

git add .
git commit -m "Your meaningful commit message"

Please keep your commits focused and clear. And remember to be kind to fellow contributors; keep your commits concise.

Sync with Upstream

Periodically, sync your forked repository with the original (upstream) repository to stay up-to-date with the latest changes.

git remote add upstream https://github.com/adawg4/openapi-autospec.git
git fetch upstream
git merge upstream/main

This ensures you're working on the most current version. Stay fresh!

Open a Pull Request

Time to share your contribution! Head over to the original repository and open a Pull Request (PR). Maintainers will review your work. Your PR will undergo thorough review and testing. The maintainers will provide feedback, and you can collaborate to make your contribution even better.

Celebrate 🎉

Congratulations! Your contribution is now part of this repo. Thank you for making OpenAPI AutoSpec even more magical. We can't wait to see what you create!