From 91bbe5504caf4503bb73c9f22fa34370ee8ee129 Mon Sep 17 00:00:00 2001 From: Ramon Petgrave <32398091+ramonpetgrave64@users.noreply.github.com> Date: Wed, 12 Apr 2023 15:34:18 -0400 Subject: [PATCH 1/4] Create pull_request_template.md --- .github/pull_request_template.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..a79596f74 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ + +___ +Read through our [developer docs](https://lyft.github.io/cartography/dev/developer-guide.html) + +If you are modifying or implementing a new intel module +- [ ] Update the [schema](https://github.com/lyft/cartography/tree/master/docs/root/modules) +- [ ] Use our NodeSchema [data model](https://lyft.github.io/cartography/dev/writing-intel-modules.html#defining-a-node) +- [ ] Use specialized functions + - [ ] `get_` to [fetch](https://lyft.github.io/cartography/dev/writing-intel-modules.html#get) the data + - [ ] `transform_` do [modifications](https://lyft.github.io/cartography/dev/writing-intel-modules.html#transform) against the data + - [ ] `load_` begin the database [write](https://lyft.github.io/cartography/dev/writing-intel-modules.html#load) transactions + - [ ] `cleanup_` to [remove](https://lyft.github.io/cartography/dev/writing-intel-modules.html#cleanup) stale nodes and relationships +- [ ] Add [tests](https://lyft.github.io/cartography/dev/writing-intel-modules.html#making-tests) + - [ ] Unit tests + - [ ] Test your `transform_` function with sample data + - [ ] Integration tests + - [ ] Use our test [helper functions](https://github.com/lyft/cartography/blob/master/tests/integration/util.py) + - [ ] Test that the new nodes are created + - [ ] Check the the new relationships are created + - [ ] Check that stale nodes will be removed + - [ ] Check that stale relationships will be removed From 9544ebf763e7207d6d5045bb7350ce64076f460a Mon Sep 17 00:00:00 2001 From: Ramon Petgrave <32398091+ramonpetgrave64@users.noreply.github.com> Date: Wed, 12 Apr 2023 15:38:26 -0400 Subject: [PATCH 2/4] Update pull_request_template.md --- .github/pull_request_template.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a79596f74..ce43ff893 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,14 @@ +### Summary +> Describe your changes + +### Related issues +- > Link any realted github issues ___ Read through our [developer docs](https://lyft.github.io/cartography/dev/developer-guide.html) +- [ ] PR Title starts with "Fixes: [issue number]" + If you are modifying or implementing a new intel module - [ ] Update the [schema](https://github.com/lyft/cartography/tree/master/docs/root/modules) - [ ] Use our NodeSchema [data model](https://lyft.github.io/cartography/dev/writing-intel-modules.html#defining-a-node) From 507f772167b44d0f547dbdcc07ea0900a55d7310 Mon Sep 17 00:00:00 2001 From: Ramon Petgrave <32398091+ramonpetgrave64@users.noreply.github.com> Date: Tue, 18 Apr 2023 14:27:33 -0400 Subject: [PATCH 3/4] shorten --- .github/pull_request_template.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ce43ff893..39c80ca53 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,19 +10,11 @@ Read through our [developer docs](https://lyft.github.io/cartography/dev/develop - [ ] PR Title starts with "Fixes: [issue number]" If you are modifying or implementing a new intel module -- [ ] Update the [schema](https://github.com/lyft/cartography/tree/master/docs/root/modules) +- [ ] Update the [schema](https://github.com/lyft/cartography/tree/master/docs/root/modules) and [readme](https://github.com/lyft/cartography/blob/master/docs/schema/README.md) - [ ] Use our NodeSchema [data model](https://lyft.github.io/cartography/dev/writing-intel-modules.html#defining-a-node) -- [ ] Use specialized functions - - [ ] `get_` to [fetch](https://lyft.github.io/cartography/dev/writing-intel-modules.html#get) the data - - [ ] `transform_` do [modifications](https://lyft.github.io/cartography/dev/writing-intel-modules.html#transform) against the data - - [ ] `load_` begin the database [write](https://lyft.github.io/cartography/dev/writing-intel-modules.html#load) transactions - - [ ] `cleanup_` to [remove](https://lyft.github.io/cartography/dev/writing-intel-modules.html#cleanup) stale nodes and relationships +- [ ] Use specialized functions `get_`, `transform_`, `load_`, and `cleanup_` functions - [ ] Add [tests](https://lyft.github.io/cartography/dev/writing-intel-modules.html#making-tests) - - [ ] Unit tests - - [ ] Test your `transform_` function with sample data + - [ ] Unit tests: Test your `transform_` function with sample data - [ ] Integration tests - [ ] Use our test [helper functions](https://github.com/lyft/cartography/blob/master/tests/integration/util.py) - - [ ] Test that the new nodes are created - - [ ] Check the the new relationships are created - - [ ] Check that stale nodes will be removed - - [ ] Check that stale relationships will be removed + - [ ] Test a cleanup job From 5143d30caddd48031bc30ebe0cabbe5e0ebcd148 Mon Sep 17 00:00:00 2001 From: Alex Chantavy Date: Sat, 20 Jul 2024 14:27:47 -0700 Subject: [PATCH 4/4] update checklist --- .github/pull_request_template.md | 33 ++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 39c80ca53..8ea718de8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1,25 @@ ### Summary +> Describe your changes. -> Describe your changes -### Related issues -- > Link any realted github issues -___ -Read through our [developer docs](https://lyft.github.io/cartography/dev/developer-guide.html) -- [ ] PR Title starts with "Fixes: [issue number]" +### Related issues or links +> Include links to relevant issues or other pages. -If you are modifying or implementing a new intel module +- https://github.com/lyft/cartography/issues/... + + +### Proof that this works +> We can merge your change in faster if we see that it works. For example, if making a change to the graph, include a +> screenshot showing what the graph looked like before and after your changes. You can also include console log traces +> showing what happened before and after your changes. + + + +### Checklist + +- [ ] Update/add unit or integration tests + +If you are modifying or implementing an intel module: - [ ] Update the [schema](https://github.com/lyft/cartography/tree/master/docs/root/modules) and [readme](https://github.com/lyft/cartography/blob/master/docs/schema/README.md) -- [ ] Use our NodeSchema [data model](https://lyft.github.io/cartography/dev/writing-intel-modules.html#defining-a-node) -- [ ] Use specialized functions `get_`, `transform_`, `load_`, and `cleanup_` functions -- [ ] Add [tests](https://lyft.github.io/cartography/dev/writing-intel-modules.html#making-tests) - - [ ] Unit tests: Test your `transform_` function with sample data - - [ ] Integration tests - - [ ] Use our test [helper functions](https://github.com/lyft/cartography/blob/master/tests/integration/util.py) - - [ ] Test a cleanup job +- [ ] Use the NodeSchema [data model](https://lyft.github.io/cartography/dev/writing-intel-modules.html#defining-a-node)