Skip to content

Commit 446eb81

Browse files
committed
Added documentation for the .env files
1 parent c61ed3b commit 446eb81

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ plugins/your-awesome-plugin/ # → Root of your plugin.
5353
├── vendor/ # → Composer packages (never edit).
5454
├── vendor_prefixes/ # → Prefixed composer packages for non-conflict mode (never edit).
5555
├── .codeception.yml # → Main codeception config.
56+
├── .env.example # → Example for the .env.development and .env.production files
5657
├── .eslintignore # → JS Coding Standards ignore file.
5758
├── .eslintrc.js # → JS Coding Standards config.
5859
├── .gitconfig # → Config for git.
@@ -99,6 +100,8 @@ or
99100
npm run cs:php
100101
```
101102

103+
Pay attention, tests have a bit another coding standards because testing libraries all using camelCase format for methods, function, variables, and properties.
104+
102105
PHPCS checked before each commit, before the push, and in GH Actions.
103106

104107
### JS Coding Standard (JSCS)
@@ -121,6 +124,10 @@ You can check SCSSCS using a CLI:
121124
npm run cs:scss
122125
```
123126

127+
## Environments
128+
129+
For any constants you can create the `.env.development` and `.env.production` files. For example, we use these constants from the `.env.example` file for the browserSync inside the Laravel Mix config and for acceptance tests.
130+
124131
## Frontend
125132

126133
All assets are located in `assets/src/*`.

0 commit comments

Comments
 (0)