2.1 KiB
How to contribute
Did you find a bug?
-
Ensure the bug was not already reported by searching on GitHub under Issues.
-
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
-
Do not open up a GitHub issue if the bug is a security vulnerability, and instead to refer to our security policy.
Do you intend to add a new feature or change an existing one?
-
Suggest your change inside an issue.
-
Do not open a pull request on GitHub until you have collected positive feedback about the change.
Did you write a patch that fixes a bug?
-
Open a new GitHub pull request with the patch.
-
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
Development of this action
- Install act
- Make a symlink for
actto work properly:ln -s . golangci-lint-action - Install dependencies:
npm install - Build:
npm run build - Run
npm run localafter any change to test it
Testing custom plugins
To test the custom plugin support:
- Create a
.custom-gcl.ymlfile in one of the sample directories (e.g.,sample-go-mod/.custom-gcl.yml) - Add a plugin configuration following the golangci-lint plugin documentation
- Update the
.golangci.ymlfile to enable the custom linter - Run the action and verify that it builds and uses the custom binary
Releases
npm version <major | minor | patch> -m "Upgrade to %s"
The "major tag" (ex: v6) should be deleted and then recreated manually.