From fe9b438a5169c0c8ca5ca130171425785a4327b6 Mon Sep 17 00:00:00 2001 From: Dolan Date: Mon, 27 Feb 2023 21:06:54 +0000 Subject: [PATCH] Update documentation --- docs/contribution-guidelines.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/contribution-guidelines.md b/docs/contribution-guidelines.md index dede758ecf..9f53eff40c 100644 --- a/docs/contribution-guidelines.md +++ b/docs/contribution-guidelines.md @@ -1,11 +1,20 @@ # Contribution Guidelines -- Include documentation reference(s) at the top of each file: +- Include documentation reference(s) at the top of each file as a comment. For example: ```ts // http://officeopenxml.com/WPdocument.php ``` + It can be a link to `officeopenxml.com` or `datypic.com` etc. + It could also be a reference to the official ECMA-376 standard: https://www.ecma-international.org/publications-and-standards/standards/ecma-376/ + +- Include a portion of the schema as a comment for cross reference. For example: + + ```ts + // + ``` + - Follow Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin. - Follow the `ESLint` rules