Skip to content

Commit 88f2f3d

Browse files
authored
Merge pull request #754 from music-encoding/fix-contributing-guidelines
docs: update CONTRIBUTING.md
2 parents 0d65cd9 + c1a70f5 commit 88f2f3d

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ To install and run Jekyll natively on your machine, please follow these steps:
5858

5959
#### Step 3b: Run Jekyll in a Docker container
6060

61-
To avoid installing Jekyll natively and to assure it comes with all the necessary dependencies, you can run it in a preconfigured container image. The publishers of Jekyll offer a corresponding Docker image for such purposes. To run it, please follow these instructions:
61+
To avoid installing Jekyll natively and to assure it comes with all the necessary dependencies, you can run it in a preconfigured container image. The publishers of Jekyll offer a corresponding [Docker image](https://github.com/envygeeks/jekyll-docker) for such purposes. To run it, please follow these instructions:
6262

6363
1. Install Docker
6464

@@ -85,6 +85,19 @@ To avoid installing Jekyll natively and to assure it comes with all the necessar
8585

8686
This will compile the site and start serving the content locally. Information on the compilation process will be output to the command shell. Once it's ready, you can open your browser and visit `http://localhost:4000` to see your local version of the website.
8787
88+
> [!NOTE]
89+
> The `$PWD` ("print working directory") command is commonly used in Unix-like operating systems to get the current working directory.
90+
> However, on other systems, especially Windows, you might need to replace it with a different command. Below are the alternatives for different command line tools:
91+
>
92+
> | Command Line Tool | Command |
93+
> |-------------------|---------|
94+
> | **Unix-like Systems** | |
95+
> | - Terminal | `$PWD` |
96+
> | **Windows Systems** | |
97+
> | - Powershell | `${PWD}` |
98+
> | - CMD | `%CD%` |
99+
> | - Git Bash for Windows | `/$(pwd)` |
100+
88101
### Step 5. Make your changes and commit
89102
90103
You should now be able to make your changes. Try to keep your commits as ‘atomic’ as possible; that is, commit only the changes necessary for a given set of functionality. Avoid large commits that change a lot of things, as this makes it harder to review your changes for unintended side effects and potential problems.

0 commit comments

Comments
 (0)