CONTRIBUTING.md

Contributing to shell-config

Thank you for your interest in contributing to shell-config! 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
6. Submit a pull request against the beta branch

Add Some New Apps / Tools

1. Open the relevant file by the new app category in here
2. Add the new app / tool to the relevant category, follow the IAppSetup type
3. Test your changes via the following command:

npm run start:dev -- install

4. Commit your changes, like fix(apps): <Explain>, and open a PR 🎉

CLI Setup Flow

1. CLI is getting updated via the shell-config update command OR installed via the init.sh script
2. Both the .zshrc configuration, and the UpdateCommand calling source <(shell-config init-script) in order to have the dynamic init command of the latest version.
3. The InitCommand kicks in, and checks all of the relevant files, tools, setups and configurations of the latest version, and update them if needed. Homebrew is been installed for both Apple Silicon and Intel based Macs. It will also backup the current .zshrc file

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. chore - changes that should not affect production user code, e.g. update dev-dependencies
2. fix - bug fixes, e.g. fix linting errors
3. feat - new features, e.g. add new command
4. docs - changes to documentation
5. ci - changes to CI configuration
6. 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 avivbens87@gmail.com.

Happy contributing!