Skip to content

Commit 0c07089

Browse files
author
Nejc Vukovic
authoredOct 28, 2023
feat: initial CONTRIBUTING.md draft (#958)
1 parent 20c419a commit 0c07089

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed
 

‎CONTRIBUTING.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contribution Guidelines
2+
3+
When contributing to `orval`, whether on GitHub or in other community spaces:
4+
5+
- Be respectful, civil, and open-minded.
6+
- Before opening a new pull request, try searching through the [issue tracker](https://github.com/anymaniax/orval/issues) for known issues or fixes.
7+
- 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.
8+
9+
## How to Contribute
10+
11+
### Prerequisites
12+
13+
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](https://github.com/anymaniax/orval/issues/new) describing the problem you would like to solve.
14+
15+
### Setup your environment locally
16+
17+
_Some commands will assume you have the Github CLI installed, if you haven't, consider [installing it](https://github.com/cli/cli#installation), but you can always use the Web UI if you prefer that instead._
18+
19+
In order to contribute to this project, you will need to fork the repository:
20+
21+
```bash
22+
gh repo fork anymaniax/orval
23+
```
24+
25+
then, clone it to your local machine:
26+
27+
```bash
28+
gh repo clone <your-github-name>/orval
29+
```
30+
31+
### Implement your changes
32+
33+
When making commits, make sure to follow the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) 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:
34+
35+
```bash
36+
git add <file> && git commit -m "feat/fix/chore/docs: commit message"
37+
```
38+
39+
### When you're done
40+
41+
When all that's done, it's time to file a pull request to upstream:
42+
43+
**NOTE**: All pull requests should target the `main` branch.
44+
45+
## Credits
46+
47+
This documented was inspired by the contributing guidelines for [create-t3-app](https://github.com/t3-oss/create-t3-app/blob/next/CONTRIBUTING.md).

0 commit comments

Comments
 (0)
Please sign in to comment.