Skip to content

Guidelines for Migrating AIP lint rules #57

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.

Sign up for GitHub

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

Merged
rambleraptor merged 4 commits into from
Jun 6, 2024
Merged

Guidelines for Migrating AIP lint rules #57

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f7477d
New guidelines for migrating AIP rules
rambleraptor Jun 5, 2024
ed4d890
guidelines for migrating AIP linter rules
rambleraptor Jun 5, 2024
d5be33d
Update docs/contributing.md
rambleraptor Jun 6, 2024
3b2bcf4
add test info
rambleraptor Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,18 @@ 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. Denote each rule with a Should/Must tag.
6. Fix tests.

<!-- prettier-ignore-start -->
[aep]: https://aep.dev/
[go]: https://golang.org/
Expand Down