Skip to content

Commit e617534

Browse files
authored
Add simple CONTRIBUTING.md (#1524)
1 parent 6ac877e commit e617534

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing to graphql-shield
2+
3+
## Development setup
4+
5+
1. [Fork](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#forking-a-repository) and [clone](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#cloning-a-fork) this repository.
6+
1. [Install pnpm](https://pnpm.io/installation).
7+
1. Run `pnpm install`.
8+
1. Run `pnpm test`. All tests should pass.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
5252

5353
## Contributing
5454

55-
We are always looking for people to help us grow `graphql-shield`! If you have an issue, feature request, or pull request, let us know!
55+
We are always looking for people to help us grow `graphql-shield`! If you have an issue, feature request, or pull request, let us know! For information about development setup and more, see [CONTRIBUTING.md](CONTRIBUTING.md).
5656

5757
## License
5858

0 commit comments

Comments
 (0)