Skip to content

Commit 294c3cb

Browse files
author
iru
committed
chore(doc): simplify contrib
1 parent 2d1a33a commit 294c3cb

File tree

2 files changed

+30
-23
lines changed

2 files changed

+30
-23
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,3 @@
1-
> PR template
2-
>
3-
> * for a cleaner PR, **delete whatever is not required**
4-
> * use pull-request **drafts for visibility on WIP branches**
5-
> * unless a revision is desired in order to validate, or gather some feedback, **you are free to merge it as long as**
6-
> * validation checkers are all green-lighted
7-
> * pre-merge checklist has been reviewed. for more detail check **`/CONTRIBUTE.md`**
8-
9-
- [ ] **modules** (infra or services) have been modified?
10-
- [ ] a `README.md` has been added
11-
- [ ] if modules are relevant to usage-case understanding `diagram.py/png` have been updated accodingly
12-
- [ ] if prerequirements have been modified, update accordingly on
13-
- [ ] README's
14-
- [ ] Sysdig docs
15-
- [ ] **input/output** variables have been modified?
16-
- [ ] terraform-docs has been updated acordingly
17-
- [ ] if these inputs are mandatory, they've been changed on
18-
- [ ] examples
19-
- [ ] testing use-cases
20-
- [ ] snippets on README's
21-
- [ ] snippets on Secure Platform onboarding
22-
- [ ] had any problems developing this PR? add it to the readme **troubleshooting** list! may come handy to someone
1+
<!--
2+
check contribution guidelines at https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/CONTRIBUTE.md#contribution-checklist
3+
-->

CONTRIBUTE.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,33 @@
1616

1717
# Pull Request
1818

19-
Should any pre-merge test fail, check `/.github/workflows/ci-integration-test.yaml` to identify what's required
19+
> TLDR; Should any pre-merge test fail, check `/.github/workflows/ci-integration-test.yaml` to identify what's required
20+
21+
## 0. General Guidelines
22+
23+
* Use pull-request **drafts for visibility on WIP branches**
24+
* Unless a revision is desired in order to validate, or gather some feedback, **you are free to merge it as long as**
25+
* validation checkers are all green-lighted
26+
* you've got permissions to do so :)
27+
* Check wether anything else is required for your contribution
28+
29+
### Contribution checklist
30+
31+
- [ ] **modules** (infra or services) have been modified?
32+
- [ ] a `README.md` file has been added to the folder
33+
- [ ] if modules are relevant to usage-case understanding `diagram.py/png` have been updated accodingly
34+
- [ ] if pre-requirements have been modified, update accordingly on
35+
- [ ] README's
36+
- [ ] Sysdig docs
37+
- [ ] **input/output** variables have been modified?
38+
- [ ] terraform-docs has been updated accordingly
39+
- [ ] if these inputs are mandatory, they've been changed on
40+
- [ ] examples
41+
- [ ] testing use-cases
42+
- [ ] snippets on README's
43+
- [ ] snippets on Secure Platform onboarding
44+
- [ ] had any problems developing this PR? add it to the readme **troubleshooting** list! may come handy to someone
45+
2046

2147
## 1. Check::Pre-Commit
2248

0 commit comments

Comments
 (0)