Skip to content

Commit

Permalink
Merge pull request #4 from doras-to/update-contribution-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tommerty authored Dec 6, 2023
2 parents bcedc87 + c11207b commit 061e519
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 31 deletions.
17 changes: 0 additions & 17 deletions .github/pr-commenter.yml

This file was deleted.

24 changes: 15 additions & 9 deletions .github/workflows/pr-commenter.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
name: "PR Commenter"
on:
- pull_request_target
pull_request:
branches:
- master
types:
- opened

jobs:
pr-comment:
runs-on: ubuntu-latest
steps:
- uses: exercism/[email protected]
with:
github-token: "${{ github.token }}"
config-file: ".github/pr-commenter.yml"
test:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: mshick/[email protected]
with:
message: |
## Thanks for the PR!
We'll review the changes and preview the site before merging. :tada: If you have any additional questions or comments, please feel free to add them here. :heart:
11 changes: 6 additions & 5 deletions src/content/docs/contributing/contribute-to-the-docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,18 @@ First off, thanks for considering contributing to the docs! We're always looking
This is only required if you wish to build and preview the site locally. If you're not interested in doing this and just want to write pure markdown, you can skip this section.
:::
Download the following software:
- [Node.js](https://nodejs.org/en/)
- [Git](https://git-scm.com/downloads)
- [PNPM](https://pnpm.io/installation)
- [Node.js](https://nodejs.org/en/) - Needed to run the scripts.
- [Git](https://git-scm.com/downloads) - Needed to clone the repository.
- [PNPM](https://pnpm.io/installation) - Needed to install the dependencies.
- [GitHub Desktop](https://desktop.github.com/) (optional)
- [Visual Studio Code](https://code.visualstudio.com/) (you can use any code editor you like, but this is what we use.)

NOTE: You may need to restart your computer after installing these tools.

## Getting started
1. Head over to GitHub and `fork` the [docs repository](https://github.com/doras-to/docs). There's a button to do this in the top right of the repository. This will create a copy of the docs repository in your own GitHub account. You can call it whatever you want!
2. Once you've done that, you can clone your forked repository to your computer. The easiest way to do this would be using [GitHub Desktop](https://desktop.github.com/), but you can also use the command line if you prefer.
3. Open the repo in your code editor of choice. We use [Visual Studio Code](https://code.visualstudio.com/), but you can use any code editor you like.
2. Once you've created the fork head over to your forked repo (https://github.com/YOURUSERNAME/docs most likely), and you can clone your forked repository to your computer. The easiest way to do this would be using [GitHub Desktop](https://desktop.github.com/), but you can also use the command line if you prefer.
3. Once you've cloned it, open the repo in your code editor of choice. We use [Visual Studio Code](https://code.visualstudio.com/), but you can use any code editor you like.
4. Open a terminal in your code editor and run the following commands:
```bash
pnpm install
Expand Down

0 comments on commit 061e519

Please sign in to comment.