Skip to content
This repository was archived by the owner on Jan 20, 2025. It is now read-only.

Commit cc83c54

Browse files
committed
doc: explain the use of tags in the dynamic content
1 parent 8460de4 commit cc83c54

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,17 @@ npm run populate-implementations
5757

5858
This will autopolulate the details and implementations sections of the website, respectively. So make sure to commit the changes.
5959

60+
### Improve the content via PR(s)
61+
62+
If you want to enhance any page, you can do so as you would in any other project (via a Pull Request, [example](https://github.com/secure-dashboards/openjs-security-program-standards/pull/9)). However, please note certain rules, as some parts of the files are dynamically generated, and your changes could be overwritten.
63+
64+
**Rules**
65+
1. Metadata is added automatically. Manual additions or modifications to metadata are not allowed.
66+
2. You can contribute any content to any file, but avoid making changes within the sections enclosed by specific tags, as these sections are dynamically generated. For example:
67+
```plaintext
68+
OK
69+
<!-- DESCRIPTION:START -->
70+
AVOID (AUTOMATED)
71+
<!-- DESCRIPTION:END -->
72+
OK
73+
```

0 commit comments

Comments
 (0)