Issue 533: Update developer documentation #541
Conversation
dogle-scottlogic
added
the
community structure
There was a problem hiding this comment.
Honestly, I think this should be at the root of the entire project called CONTRIBUTING.md. It would be easier for folks to find it. Thoughts on this @dogle-scottlogic?
|
@damienjburks - we could do, the other option is to link to this doc from the root README.md so there's just a single doc at the root level to get started with the project but happy either way? |
|
@dogle-scottlogic I think the better approach would be to move it out to the root as CONTRIBUTING.md. Let's do that. |
| ### Snippets | ||
|
|
||
| [VSCode snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets) are defined for common [features](.vscode/common-features.code-snippets), [threats](.vscode/common-threats.code-snippets) and [controls](.vscode/common-controls.code-snippets). | ||
| To make use of these snippets start typing the snippet prefix in any `yaml` file and VSCode will offer you the option to auto-complete the snippet e.g. |
There was a problem hiding this comment.
Would you perhaps be able to add a grid/summary of the available snippets (general info about single common features, threats etc.).
Can be part of a different PR.
There was a problem hiding this comment.
Just to clarify, are you asking for a high-level list of each .code-snippets file and it's purpose as opposed to a list of each individual snippet and what it's for? The latter seems like a bit of duplication and would be hard to maintain.
There was a problem hiding this comment.
Just a high level list e.g.
threats-file: adds the template for a threats file
threat: adds a template for a single threat
CT*: adds a common threat
Does that make sense?
I don't see us adding many more types of snippets, other than maintaining the common features, threats and controls, but those would be covered by the general explanation.
There was a problem hiding this comment.
you mean something like this?
There was a problem hiding this comment.
Yup - just saves people having to go digging to see what is available.
dogle-scottlogic
dismissed stale reviews from sshiells-scottlogic and damienjburks
via
80b3253
Update the developer document to be a more complete contributors guide.
Resolves issue #533