From 5f7477d4b7f5e32a9cd942548406bb73e0676cf2 Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Tue, 4 Jun 2024 19:42:01 -0700 Subject: [PATCH 1/4] New guidelines for migrating AIP rules --- docs/contributing.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/contributing.md b/docs/contributing.md index 53b17e8d..c37e4c71 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -150,6 +150,17 @@ git commit --allow-empty -m 'feat: new minor release' git commit --allow-empty -m 'fix: new patch release' ``` +## Migrating rules +Rules in this linter need to be ported from the AIP standard to the AEP standard. + +When making a conversion PR, the following steps should be taken: + +1. Copy over new rules (and previously deleted rules) from the AIP linter. +2. Change all references of the `name` field to `path` in the documentation. +3. Remove any rules that no longer apply. +4. For each existing AIP rule, check the AEPs and see what changes (if any) are necessary. +5. Fix tests. + [aep]: https://aep.dev/ [go]: https://golang.org/ From ed4d8909622e54641a292a8882929034935850f2 Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Tue, 4 Jun 2024 19:42:30 -0700 Subject: [PATCH 2/4] guidelines for migrating AIP linter rules --- docs/contributing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/contributing.md b/docs/contributing.md index c37e4c71..6ee7d8ff 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -159,7 +159,8 @@ When making a conversion PR, the following steps should be taken: 2. Change all references of the `name` field to `path` in the documentation. 3. Remove any rules that no longer apply. 4. For each existing AIP rule, check the AEPs and see what changes (if any) are necessary. -5. Fix tests. +5. Denote each rule with a Should/Must tag. +6. Fix tests. [aep]: https://aep.dev/ From d5be33d4d35ceaa268b01f2bfd3174343f7a363e Mon Sep 17 00:00:00 2001 From: Alex Stephen <1325798+rambleraptor@users.noreply.github.com> Date: Wed, 5 Jun 2024 22:05:44 -0700 Subject: [PATCH 3/4] Update docs/contributing.md Co-authored-by: Yusuke Tsutsumi --- docs/contributing.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/contributing.md b/docs/contributing.md index 6ee7d8ff..04556ce4 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -151,6 +151,7 @@ git commit --allow-empty -m 'fix: new patch release' ``` ## Migrating rules + Rules in this linter need to be ported from the AIP standard to the AEP standard. When making a conversion PR, the following steps should be taken: From 3b2bcf4174d275bfd34b394f55f9428b2ed8ef38 Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Thu, 6 Jun 2024 10:43:52 -0700 Subject: [PATCH 4/4] add test info --- docs/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.md b/docs/contributing.md index 04556ce4..3d60c82a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -161,7 +161,7 @@ When making a conversion PR, the following steps should be taken: 3. Remove any rules that no longer apply. 4. For each existing AIP rule, check the AEPs and see what changes (if any) are necessary. 5. Denote each rule with a Should/Must tag. -6. Fix tests. +6. Run tests with `go test ./...` and fix any issues. [aep]: https://aep.dev/