Skip to content

Commit 24a7348

Browse files
authored
README tweaks (#130)
* README tweaks * Undo Note
1 parent e2665ac commit 24a7348

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

README.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# DDEV Drupal Contrib
77

8-
DDEV integration for developing Drupal contrib projects. As a general philosophy, your contributed module is the center of the universe. The codebase layout (see image below) and commands in this project [match the Gitlab CI approach](https://git.drupalcode.org/project/gitlab_templates) from the Drupal Association.
8+
DDEV integration for developing Drupal contrib projects. As a general philosophy, your contributed module/theme is the center of the universe. The codebase layout (see image below) and commands in this project [match the Gitlab CI approach](https://git.drupalcode.org/project/gitlab_templates) from the Drupal Association.
99

1010

1111
## Install
@@ -93,14 +93,12 @@ In `.ddev/config.local.yaml` set the location relative to webroot (which usually
9393
```yaml
9494
web_environment:
9595
- ...
96-
- DRUPAL_PROJECTS_PATH=modules
96+
- DRUPAL_PROJECTS_PATH=modules/custom
9797
```
9898

9999
Then run `ddev restart` to update the symlink location.
100100

101-
All [ddev-drupal-contrib commands](#commands) run against your project code in the configured symlink location.
102-
103-
To use with Drupal themes, set `DRUPAL_PROJECTS_PATH=themes/custom` in your config.
101+
To use with Drupal themes, set `DRUPAL_PROJECTS_PATH=themes/custom` in your config.local.yaml.
104102

105103
## Example of successful test
106104

@@ -138,11 +136,22 @@ ddev phpcbf -q
138136

139137
3. Mark the file as executable: `chmod +x pre-commit`.
140138

141-
## Add-on tests
139+
## Troubleshooting
140+
141+
"Error: unknown command":
142+
143+
The commands from this addon are available when the project type is `drupal`. Make sure the `type` configuration is correctly set in `.ddev/config.yaml`:
144+
145+
```yaml
146+
type: drupal
147+
```
148+
149+
> [!TIP]
150+
> Remember to run `ddev restart` if `.ddev/config.yaml` has been updated.
142151

143-
Tests are done with Bats. It is a testing framework that uses Bash.
152+
## Contributing
144153

145-
To run tests locally you need to first install bats' git submodules with:
154+
Tests are done with Bats. It is a testing framework that uses Bash. To run tests locally you need to first install bats' git submodules with:
146155

147156
```bash
148157
git submodule update --init
@@ -160,30 +169,15 @@ variable.
160169
i.e. `TEST_DRUPAL_CORE=11 ./tests/bats/bin/bats ./tests`.
161170

162171
Tests are triggered automatically on every push to the
163-
repository, and periodically each night. The automated tests are agains all of
172+
repository, and periodically each night. The automated tests are against all of
164173
the supported Drupal core versions.
165174

166-
Please make sure to attend to test failures when they happen. Others will be
167-
depending on you.
168-
169-
Also, consider adding tests to test for bugs or new features on your PR.
175+
Also, consider adding tests in your PR.
170176

171177
To learn more about Bats see the [documentation][bats-docs].
172178

173179
[bats-docs]: https://bats-core.readthedocs.io/en/stable/
174180

175-
## Troubleshooting
176-
177-
"Error: unknown command":
178-
179-
The commands from this addon are available when the project type is `drupal`. Make sure the `type` configuration is correctly set in `.ddev/config.yaml`:
180-
181-
```yaml
182-
type: drupal
183-
```
184-
185-
Don't forget to run `ddev restart` if `.ddev/config.yaml` has been updated.
186-
187181
## Credits
188182

189183
Contributed and maintained by Moshe Weitzman ([@weitzman](https://github.com/weitzman)) and

0 commit comments

Comments
 (0)