cartography icon indicating copy to clipboard operation
cartography copied to clipboard

Create pull_request_template.md

Open ramonpetgrave64 opened this issue 1 year ago • 6 comments

Adds some guidance on how to edit/create intel modules

ramonpetgrave64 avatar Apr 12 '23 19:04 ramonpetgrave64

@resilience-jychp , what do you think?

ramonpetgrave64 avatar Apr 17 '23 20:04 ramonpetgrave64

@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.

jychp avatar Apr 17 '23 20:04 jychp

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 avatar Apr 18 '23 18:04 achantavy

@achantavy @resilience-jychp Thanks. I've shortened it and mentioned the readme

ramonpetgrave64 avatar Apr 18 '23 18:04 ramonpetgrave64

@ramonpetgrave64 may be you can add a reminder for "extra-index" in your checklist

jychp avatar Jun 07 '23 07:06 jychp

  • ~Create or update schema docs under docs/root/modules/.~ (Should have read properly)

chandanchowdhury avatar May 17 '24 15:05 chandanchowdhury