Skip to content

Fix README customization example #30

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

Merged
DannyNs merged 1 commit into from
Mar 8, 2026
Merged

Fix README customization example #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ See [docs/BRANCH-RULES.md](docs/BRANCH-RULES.md) for full details and manual set

### Adding CI Steps

Edit the `checks` job in `feature.yml` to add your build, test, and lint steps:
Edit the `checks` job in `feature.yml` to add your build, test, and lint steps. Keep the `if:` condition on each step so that non-feature PRs (like back-merge PRs) pass without running CI:

```yaml
# In .github/workflows/feature.yml
Expand All @@ -120,15 +120,23 @@ checks:
runs-on: ubuntu-latest
needs: validate
steps:
- name: Skip non-feature branches
if: needs.validate.outputs.is_feature != 'true'
run: echo "Not a feature branch — skipping CI checks."

- uses: actions/checkout@v4
if: needs.validate.outputs.is_feature == 'true'

- name: Install dependencies
if: needs.validate.outputs.is_feature == 'true'
run: npm ci

- name: Lint
if: needs.validate.outputs.is_feature == 'true'
run: npm run lint

- name: Test
if: needs.validate.outputs.is_feature == 'true'
run: npm test
```

Expand Down