Skip to content

Commit b27828f

Browse files
Updated CONTRIBUTION.md file (#3896)
Co-authored-by: Brian MacDonald <[email protected]>
1 parent 7489361 commit b27828f

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,37 @@
11
# Contribute to Temporal Documentation Locally
22

3-
1. **Clone the Repository**
3+
1. **Fork the Repository**
4+
Create a fork of this repository.
5+
*This creates a copy of this repository to your github account*
6+
7+
2. **Clone the Repository**
48
Run the following commands in your terminal to clone the repository and navigate into it:
59
```bash
610
git clone https://github.com/YOUR_USERNAME/documentation.git
711
cd documentation
812
```
913

10-
2. **Open the Repository in Your IDE**
14+
3. **Open the Repository in Your IDE**
1115
Open the project in your preferred IDE, such as Visual Studio Code. Locate the `/docs` directory, which contains all the content served on `docs.temporal.io`. Identify the changes you want to make.
1216

13-
3. **Create a New Branch**
17+
4. **Create a New Branch**
1418
If you're creating a pull request, create a new branch and switch to it:
1519
```bash
1620
git checkout -b my-documentation-contribution
1721
```
1822

19-
4. **Follow the Style Guide**
23+
5. **Follow the Style Guide**
2024
Refer to [STYLE.md](./STYLE.md) for the documentation style guidelines.
2125

22-
5. **Preview Your Changes Locally**
26+
6. **Preview Your Changes Locally**
2327
Run the following commands to preview the site locally:
2428
```bash
2529
yarn # Install site dependencies
2630
yarn start # Start the website on a local port
2731
yarn build # Check for build warnings or errors
2832
```
2933

30-
6. **Stage Your Changes**
34+
7. **Stage Your Changes**
3135
Use the following commands to stage and commit your changes:
3236
```bash
3337
git status # Check the status of your changes
@@ -36,7 +40,7 @@
3640
git push origin my-documentation-contribution # Push changes
3741
```
3842

39-
7. **Create a Pull Request**
43+
8. **Create a Pull Request**
4044
- After pushing, GitHub provides a link in the terminal to create a PR. Open the link or navigate to your fork on GitHub.
4145
- Click the option to create a Pull Request (PR).
4246
- Provide a descriptive PR title and explanation.

0 commit comments

Comments
 (0)