44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
## How to contribute
|
|
|
|
### Did you find a bug?
|
|
|
|
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/golangci/golangci-lint-action/issues).
|
|
|
|
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/golangci/golangci-lint-action/issues/new).
|
|
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](https://github.com/golangci/golangci-lint-action?tab=security-ov-file).
|
|
|
|
### Do you intend to add a new feature or change an existing one?
|
|
|
|
* Suggest your change inside an [issue](https://github.com/golangci/golangci-lint-action/issues).
|
|
|
|
* 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
|
|
|
|
1. Install [act](https://github.com/nektos/act#installation)
|
|
2. Make a symlink for `act` to work properly: `ln -s . golangci-lint-action`
|
|
3. Install dependencies: `npm install`
|
|
4. Build: `npm run build`
|
|
5. Run `npm run local` after any change to test it
|
|
|
|
### Releases
|
|
|
|
```bash
|
|
npm version <major | minor | patch> -m "Upgrade to %s"
|
|
```
|
|
|
|
- https://docs.npmjs.com/cli/v11/commands/npm-version
|
|
|
|
The "major tag" (ex: `v6`) should be deleted and then recreated manually.
|