Vishwanath Martur fdbf48b097 Add CI to automate heavy PR load
Related to #1365

Implement CI to automate heavy PR load using `awesome-lint`.

* **.github/workflows/main.yml**
  - Add a step to run `awesome-lint` on `readme.md` after the checkout step.
* **.github/workflows/repo_linter.sh**
  - Add `npx awesome-lint` command to lint the repository after cloning.
* **readme.md**
  - Mention the usage of `awesome-lint` for CI in the introduction.
  - Add a section about `awesome-lint` in the "Contribution guide".
* **contributing.md**
  - Add instructions for running `awesome-lint` before submitting a PR.
  - Mention the requirement to pass `awesome-lint` in the PR guidelines.
2025-03-09 23:46:28 +05:30

17 lines
356 B
YAML

on:
pull_request:
branches: [main]
paths:
- 'readme.md'
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: awesome-lint
run: ./.github/workflows/repo_linter.sh
- name: Run awesome-lint on readme.md
run: npx awesome-lint readme.md