Skip to content

Commit

Permalink
add small section for adding documentation (#3960)
Browse files Browse the repository at this point in the history
  • Loading branch information
n1ru4l authored Dec 2, 2021
1 parent 6f2612b commit 38d358c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ Creating a good reproduction really helps contributors investigate and resolve y

Improving the documentation, examples, and other open source content can be the easiest way to contribute to the library. If you see a piece of content that can be better, open a PR with an improvement, no matter how small! If you would like to suggest a big change or major rewrite, we’d love to hear your ideas but please open an issue for discussion before writing the PR.

If you want to edit the documentation locally you have to clone this project, install the dependencies using `yarn` and run the command `yarn build:api-docs`.
Afterwards, run `yarn workspace @graphql-tools/website dev` and visit `http://localhost:3000`. All the documentation can be found within `website/src/pages/docs`.

### Responding to issues

In addition to reporting issues, a great way to contribute to GraphQL Tools is to respond to other peoples' issues and try to identify the problem or help them work around it. If you’re interested in taking a more active role in this process, please go ahead and respond to issues.
Expand Down

1 comment on commit 38d358c

@vercel
Copy link

@vercel vercel bot commented on 38d358c Dec 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.