diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d74f5fae0..a76523ed18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,29 @@ # 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 @@ -27,7 +31,7 @@ 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 @@ -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.