Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 1.93 KB
Raw

Contribution Guidelines

When contributing to orval, whether on GitHub or in other community spaces:

  • Be respectful, civil, and open-minded.
  • Before opening a new pull request, try searching through the issue tracker for known issues or fixes.
  • If you want to make code changes based on your personal opinion(s), make sure you open an issue first describing the changes you want to make, and open a pull request only when your suggestions get approved by maintainers.

How to Contribute

Prerequisites

In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by opening an issue describing the problem you would like to solve.

Setup your environment locally

Some commands will assume you have the Github CLI installed, if you haven't, consider installing it, but you can always use the Web UI if you prefer that instead.

In order to contribute to this project, you will need to fork the repository:

gh repo fork orval-labs/orval

then, clone it to your local machine:

gh repo clone <your-github-name>/orval

Implement your changes

When making commits, make sure to follow the conventional commit guidelines, i.e. prepending the message with feat:, fix:, chore:, docs:, etc... You can use git status to double check which files have not yet been staged for commit:

git add <file> && git commit -m "feat/fix/chore/docs: commit message"

When you're done

When all that's done, it's time to file a pull request to upstream:

NOTE: All pull requests should target the main branch.

Credits

This document was inspired by the contributing guidelines for create-t3-app.