Skip to content

Latest commit

 

History

History
executable file
·
59 lines (38 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
59 lines (38 loc) · 1.43 KB

Contributing to alfred-engage-contact

Thank you for your interest in contributing to alfred-engage-contact 🎉 !

We welcome contributions from everyone.

Getting Started

To get started, follow these steps:

  1. Fork the repository
  2. Clone your forked repository
  3. Install dependencies with npm ci --no-fund --no-audit --no-progress
  4. Make changes
  5. Test your changes locally:
npx fast-alfred -t $(cat package.json | jq -r '.version')
(cd build && open *.alfredworkflow)
  1. Review your changes with your Alfred app

Consistent Development Environment 🥷

You can use the following command, in order to trigger build & pack for each save ✨

find ./src -type f -name "*.ts" | entr -s "npx fast-alfred -t $(cat package.json | jq -r '.version')"

Commit Message Guidelines

We follow the Conventional Commits specification. Make sure your commit messages follow the format below:

<type>(optional scope): <description>

Available types:

  1. fix - bug fixes, e.g. fix linting errors
  2. feat - new features, e.g. add new command
  3. docs - changes to documentation
  4. For breaking changes, add a BREAKING CHANGE section to the commit message body:
feat: <description>

BREAKING CHANGE: <description>

Contact

If you have any questions or concerns, please contact us at [email protected].

Happy contributing!