Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create pull_request_template.md #1157

Merged
merged 4 commits into from
Jul 20, 2024
Merged

Create pull_request_template.md #1157

merged 4 commits into from
Jul 20, 2024

Conversation

ramonpetgrave64
Copy link
Contributor

Adds some guidance on how to edit/create intel modules

@ramonpetgrave64
Copy link
Contributor Author

@resilience-jychp , what do you think?

@jychp
Copy link
Collaborator

jychp commented Apr 17, 2023

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

@achantavy
Copy link
Contributor

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.

@ramonpetgrave64
Copy link
Contributor Author

ramonpetgrave64 commented Apr 18, 2023

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

@jychp
Copy link
Collaborator

jychp commented Jun 7, 2023

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

@chandanchowdhury
Copy link
Collaborator

chandanchowdhury commented May 17, 2024

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

@achantavy achantavy merged commit e149967 into master Jul 20, 2024
5 checks passed
@achantavy achantavy deleted the ramonpetgrave64-patch-1 branch July 20, 2024 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants