Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.81 KB
Raw

Contributing

Suggestions and contributions are always welcome! Please discuss larger changes via issue before submitting a pull request.

Adding a new linter

If you want to add support for an additional linter, please open an issue to discuss its inclusion in the project. Afterwards, you can follow these steps to add support for your linter:

  • Clone the repository and install its dependencies with yarn install.
  • Create a new class for the linter, e.g. src/linters/my-linter.js. Have a look at the other files in that directory to see what functions the class needs to implement.
  • Import your class in the src/linters/index.js file.
  • Provide a sample project for the linter under test/linters/projects/my-linter/. It should be simple and contain a few linting errors which your tests will detect.
  • Provide the expected linting output for your sample project in a test/linters/params/my-linter.js file. Import this file in test/linters/linters.test.js. You can run the tests with yarn test.
  • Update the action.yml file with the options provided by the new linter.
  • Mention your linter in the README.md file.
  • Update the test workflow file.

Release process

To release a new version using semantic versioning follow these steps:

  1. Bump the version in package.json.
  2. Create a commit with a message like "v1.1.1".
  3. Tag that commit with the same message.
  4. Create a release from that tag on GitHub (this will publish it on the Action Marketplace, too) with a changelog of the user-facing changes.

Changelog format:

- Message (PR number, commit hash)
- Message (PR number, commit hash)
- …

https://github.com/wearerequired/lint-action/compare/<old tag>...<new tag>