Skip to content

Commit 3a0b979

Browse files
committed
Enhance readme guidelines with additional clarity and structure recommendations
1 parent 07254ea commit 3a0b979

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

_mydocs/contribute/readme-guidelines.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ next_reading: true
1111

1212
The `README.md` file with your library will be displayed alongside your library on [daxlib.org](https://daxlib.org/). Its content must follow these guidelines to ensure consistency and to be approved for publication.
1313

14+
- **Use professional language**. No profanity, offensive content, or inappropriate terminology.
15+
- **Be concise and relevant**. Include only information that helps users understand and use your library effectively.
16+
- **Keep the structure simple and organized**. Use clear headings, bullet points, and logical sections for easy reading.
1417
- **External links** are permitted only if they are safe and trustworthy. All links will be verified using Google Safe Browsing (https://transparencyreport.google.com/safe-browsing/search).
1518
- **Do not** include images that **imitate**, replicate, or closely resemble **UI elements** from the DAX Lib website.
1619
- **Do not embed images** or assets as Base64. **Use standard URLs** to reference all media assets.

0 commit comments

Comments
 (0)