diff --git a/docs/content/contributing/index.md b/docs/content/contributing/index.md index 188491ffb..823fd82e1 100644 --- a/docs/content/contributing/index.md +++ b/docs/content/contributing/index.md @@ -25,7 +25,7 @@ Where each of the projects are synthesized. ### **packages/pdk** -A special 'uber' package which pulls in all of the other packages into a single distributable. This package shoudl only ever have edits to `scripts` as all src and lib are dynamically created. +A special 'uber' package which pulls in all of the other packages into a single distributable. This package should only ever have edits to `_scripts` as all content is dynamically created. ## Creating a new construct @@ -41,9 +41,9 @@ To create a new project, create a file in the `projects` directory called `/index.md` file which describes your constructs at a high level and optionally provide a tutorial on how to use it. This is very important as this content will be rendered on the docuemntation website and is the first port of call for end users. + +If creating either a `scripts`, `samples` or `assets` folder within you package, please be sure to add a subdirectory underneath with you package name to ensure correct bundling of the uber package. For example: `scripts/`. In terms of testing, it is desired for each package to aim for a _minimum of 80% coverage_ in unit tests.