Skip to content

Commit 5a672ff

Browse files
authored
Remove limitation that isn't there anymore and add Development sectio… (#7)
…n to README
1 parent e97fbfb commit 5a672ff

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ Package variable reassignment is generally confusing, though, and we recommend a
4747
The `pattern` flag can be set to a regular expression to define what variables cannot be reassigned, and `.*` is
4848
recommended if it works with your code.
4949

50-
## Limitations
50+
## Development
5151

52-
If a variable shadows the name of an import, an assignment of a field in the variable will trigger the linter. Shadowing
53-
can be confusing, so it's recommended to rename the variable.
52+
[mage](https://magefile.org/) is used for development. Run `go run mage.go -l` to see available targets.
53+
54+
For example, to run checks before sending a PR, run `go run mage.go check`.

0 commit comments

Comments
 (0)