Skip to content

Commit 376eedc

Browse files
Merge pull request #7238 from CodexRaunak/update-contributing-docs
Update Contribution.md
2 parents e2b5dda + bdf4279 commit 376eedc

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,6 +500,30 @@ Make sure you have the following prerequisites installed on your operating syste
500500

501501
## Set up your Local Development Environment
502502

503+
### Make Targets
504+
505+
Layer5 uses a `Makefile` that defines a set of rules and instructions (called **targets**) for creating, updating, and running parts of the project. Each target abstracts the underlying commands and logic, allowing to execute complex workflows using a simple `make <target>` command.
506+
507+
> **Note:** While using the make command on Windows, there sometimes arises an error in identifying the command even after it is installed (unrecognized command), this is because the PATH for the binary might not be set correctly.
508+
509+
To see the complete and current list of available make targets along with a short description of what each one does, simply run the following command from the root of the project:
510+
511+
```bash
512+
make
513+
```
514+
515+
### Environment Variables
516+
517+
Environment variables are named values used to configure how an application behaves in different environments without modifying the code.
518+
519+
| Variable | Possible Values | Description |
520+
|---------|----------------|------------|
521+
| `BUILD_FULL_SITE` | `true`, `false` | When set to `true`, enables a full site build including all collections. If not explicitly set to `true`, the project defaults to a lightweight build. |
522+
| `NODE_ENV` | `development`, `production` | Determines the build and rendering mode used by Gatsby. This is automatically set by Gatsby. <br><br>• `development` - Uses **Deferred Static Generation (DSG)** i.e pages built on demand for faster startup. <br>• `production` - Uses **Server-Side Rendering (SSR)** i.e pages rendered on each request for fresh content. |
523+
| `CI` | `true`, `false` | Indicates that the build is running in a **Continuous Integration (CI)** environment (e.g., GitHub Actions). When set to `true`, special logic is applied to page paths and redirects for GitHub Pages compatibility. This is typically set automatically by the CI system and does not need to be configured manually. |
524+
525+
---
526+
503527
Follow the following instructions to start contributing.
504528

505529
**1.** Fork [this](https://github.com/layer5io/layer5) repository.
@@ -554,7 +578,7 @@ make setup
554578
make site
555579
```
556580

557-
This will run a local webserver with "live reload" conveniently enabled. ( **NOTE**: while using the make command on Windows, there sometimes arises an error in identifying the command even after it is installed (unrecognized command), this is because the PATH for the binary might not be set correctly ).
581+
This will run a local webserver with "live reload" conveniently enabled.
558582

559583
**11.** Track your changes.
560584

0 commit comments

Comments
 (0)