Skip to content

Add actionlint instructions to CONTRIBUTING.md #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Jagriti-student wants to merge 2 commits into from
Closed

Add actionlint instructions to CONTRIBUTING.md #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6fa6f8
Add actionlint instructions to CONTRIBUTING.md
Jagriti-student Dec 6, 2025
e3eb5d8
docs: add actionlint instructions and move section under 'Before Subm…
Jagriti-student Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,18 @@ We follow [Conventional Commits](https://www.conventionalcommits.org/):
- `test:` Adding or updating tests
- `chore:` Maintenance tasks

### Linting GitHub Actions

`actionlint` is a linter that checks GitHub Actions workflow files in `.github/workflows/*.yml` for syntax errors and common issues.

Run it locally using Docker:

```bash
docker run --rm -v "$(pwd):/repo" -w /repo ghcr.io/rhysd/actionlint:latest -color
```

If there is no output, it means no issues were found.

### After Submitting

1. **CI checks**: Ensure all automated checks pass
Expand Down Expand Up @@ -273,3 +285,4 @@ Contributors will be recognized in:
## Thank You!

Your contributions make NexumDB better for everyone. We appreciate your time and effort in helping improve this project!

⚡