Skip to content

Commit fbae394

Browse files
authored
Add CONTRIBUTING.md doc (#204)
1 parent 37fd03f commit fbae394

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Thanks for being willing to contribute!
4+
5+
**Working on your first Pull Request?** You can learn how from this _free_
6+
series [How to Contribute to an Open Source Project on GitHub][egghead]
7+
8+
## Project setup
9+
10+
1. Fork and clone the repo
11+
2. Run `npm install` to install dependencies
12+
3. Create a branch for your PR with `git checkout -b pr/your-branch-name`
13+
14+
> Tip: Keep your `master` branch pointing at the original repository and make
15+
> pull requests from branches on your fork. To do this, run:
16+
>
17+
> ```
18+
> git remote add upstream https://github.com/manifoldco/swagger-to-ts.git
19+
> git fetch upstream
20+
> git branch --set-upstream-to=upstream/master master
21+
> ```
22+
>
23+
> This will add the original repository as a "remote" called "upstream," Then
24+
> fetch the git information from that remote, then set your local `master`
25+
> branch to use the upstream master branch whenever you run `git pull`. Then you
26+
> can make all of your pull request branches based on this `master` branch.
27+
> Whenever you want to update your version of `master`, do a regular `git pull`.
28+
29+
## Committing and Pushing changes
30+
31+
Please make sure to run the tests (`npm test`) before you commit your changes.
32+
33+
## Help needed
34+
35+
Please checkout the [the open issues][issues]
36+
37+
Also, please watch the repo and respond to questions/bug reports/feature
38+
requests! Thanks!
39+
40+
[all-contributors]: https://github.com/all-contributors/all-contributors
41+
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
42+
[issues]: https://github.com/manifoldco/swagger-to-ts/issues

0 commit comments

Comments
 (0)