Skip to content

Commit 92dc96d

Browse files
Document project entry format in contributing guides
1 parent 6284777 commit 92dc96d

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,26 @@ Drupal development and other Drupal related tasks.
99

1010
Missing a tool here? Just fork the repo and add your tool as a `<name>.yml` in the `_data/projects` folder.
1111

12+
```yaml
13+
# _data/projects/example-tool.yml
14+
name: Example Tool
15+
year_created: 2024
16+
source: https://github.com/example/example-tool
17+
homepage: https://example.com
18+
description: |
19+
A single sentence that will appear in the listings.
20+
requires:
21+
- php
22+
drupal_versions:
23+
- 10
24+
category:
25+
- devops
26+
recommended: true
27+
```
28+
29+
Use the same keys shown above so the site build picks up the metadata correctly.
30+
Optional keys such as `docs`, `logo`, or `similar` can be added when the information is available.
31+
1232
Make sure to follow the following rules:
1333

1434
- **Open Source:** The tool must have a public repository on Github, Gitlab, Bitbucket etc that we can link to and pull in stats from.

about.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,25 @@
2121

2222
Feel free to use this website and **add a missing tool at the `_data/projects` folder**.
2323

24+
```yaml
25+
name: My Tool
26+
year_created: 2024
27+
source: https://github.com/example/my-tool
28+
homepage: https://example.com
29+
description: |
30+
Short, human readable copy that appears on the listings page.
31+
requires:
32+
- php
33+
drupal_versions:
34+
- 10
35+
category:
36+
- devops
37+
recommended: true
38+
```
39+
40+
Copy the structure above, update the values, and submit a pull request with the new file. Include optional fields like `docs`,
41+
`logo`, or `similar` when those links are available.
42+
2443
## Issues
2544

2645
Add an issue at [github.com/theodorosploumis/drupaltools/issues](https://github.com/theodorosploumis/drupaltools/issues)

0 commit comments

Comments
 (0)