cartography
cartography copied to clipboard
Create pull_request_template.md
Adds some guidance on how to edit/create intel modules
@resilience-jychp , what do you think?
@ramonpetgrave64 may you can add :
- edit cli.py
- edit config.py
- add module description on READEME.md
May be you can refer to @achantavy Google Doc or add some precisions about auto cleanup (only Node with sub-resource link will be deleted)
May be adding a link to analysis jobs can be helpful too.
A bit out of scope but a detailed exemple of transform with n to n cardinality will be useful.
This template will be helpful.
edit cli.py edit config.py add module description on READEME.md May be you can refer to @achantavy Google Doc or add some precisions about auto cleanup (only Node with sub-resource link will be deleted) May be adding a link to analysis jobs can be helpful too. A bit out of scope but a detailed exemple of transform with n to n cardinality will be useful.
This is very good documentation feedback, thank you.
Regarding the pull request template, I think a long list like this would do better in the how to write an intel module guide instead of this checklist.
I think we should keep a pull request template to roughly 5 items max. This is meant to remind a contributor of things they might have missed, not show them how to do everything.
@achantavy @resilience-jychp Thanks. I've shortened it and mentioned the readme
@ramonpetgrave64 may be you can add a reminder for "extra-index" in your checklist
- ~Create or update schema docs under
docs/root/modules/
.~ (Should have read properly)