CONTRIBUTING.md

Contributing

Thank you for considering contributing to github-actions-workflow-ts!

Getting Started

Prerequisites

• Node.js 18+
• pnpm

Setup

1. Fork the repository
2. Create a branch with a descriptive name:

   git checkout -b feat/325-add-some-new-feature

3. Install dependencies:

   pnpm install

How to Contribute

Reporting Bugs & Requesting Features

• Use the issue tracker for bugs, feature requests and general questions.

Adding New Actions

When contributing actions to @github-actions-workflow-ts/actions, the action must meet these criteria:

Criteria	Requirement
Popularity	50+ GitHub stars
Commits	50+ commits
Activity	Non-trivial update within last 3 months
Contributors	2+ contributors
Age	Published 6+ months ago

Actions that don't meet all criteria may still be considered. Open a new issue with your justification.

Submitting Changes

Creating a Pull Request

1. Sync your main branch:

   git remote add upstream git@github.com:emmanuelnk/github-actions-workflow-ts.git
   git checkout main
   git pull upstream main

2. Rebase and push your branch:

   git checkout feat/325-add-some-new-feature
   git rebase main
   git push --set-upstream origin feat/325-add-some-new-feature

3. Create a Pull Request

Rebasing Your PR

If asked to rebase:

git checkout feat/325-add-some-new-feature
git pull --rebase upstream main
git push --force-with-lease feat/325-add-some-new-feature

Learn more: Git Rebasing | Interactive Rebase

For Maintainers

Merge Requirements

• CI passing
• 2 maintainer approvals (1 if opened by maintainer)
• No requested changes
• Up to date with main