Skip to content

Updated CONTRIBUTION.md file #3896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 13, 2025
Merged

Updated CONTRIBUTION.md file #3896

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9ac31f
Updated CONTRIBUTION.md file
prathmesh796 Oct 6, 2025
ff209ee
Merge branch 'main' into Update-CONTRIBUTION.md
brianmacdonald-temporal Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
# Contribute to Temporal Documentation Locally

1. **Clone the Repository**
1. **Fork the Repository**
Create a fork of this repository.
*This creates a copy of this repository to your github account*

2. **Clone the Repository**
Run the following commands in your terminal to clone the repository and navigate into it:
```bash
git clone https://github.com/YOUR_USERNAME/documentation.git
cd documentation
```

2. **Open the Repository in Your IDE**
3. **Open the Repository in Your IDE**
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.

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

4. **Follow the Style Guide**
5. **Follow the Style Guide**
Refer to [STYLE.md](./STYLE.md) for the documentation style guidelines.

5. **Preview Your Changes Locally**
6. **Preview Your Changes Locally**
Run the following commands to preview the site locally:
```bash
yarn # Install site dependencies
yarn start # Start the website on a local port
yarn build # Check for build warnings or errors
```

6. **Stage Your Changes**
7. **Stage Your Changes**
Use the following commands to stage and commit your changes:
```bash
git status # Check the status of your changes
Expand All @@ -36,7 +40,7 @@
git push origin my-documentation-contribution # Push changes
```

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