diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58c84d9..47246f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# πŸ›  Contributing to zsh-github-dark +# Contributing to zsh-github-dark Thanks for considering contributing! We keep things simple and clean β€” here’s how you can help: @@ -42,12 +42,14 @@ Install it via Homebrew: brew install shfmt ``` -We use `shfmt` to automatically format `src/.zshrc` for consistency. +### Pre-commit Hook (Optional) -> **Note:** Syntax checking (`zsh -n`) and formatting validation (`shfmt -d`) -> are handled automatically by GitHub Actions CI. +Automatically format code before commits: ---- +```bash +cp git-hooks/pre-commit .git/hooks/ +chmod +x .git/hooks/pre-commit +``` ### πŸ”Ή Pre-Commit Hook Setup @@ -80,10 +82,4 @@ These extensions are optional but highly recommended. ## πŸ›‘ License -By contributing, you agree that your code will be licensed under the -[MIT License](LICENSE). - ---- - -Thank you for helping make this project better! Built with πŸ’› by -[Yellow Pine](https://github.com/yellow-pine). +By contributing, you agree your code will be licensed under the [MIT License](LICENSE). diff --git a/README.md b/README.md index 3239366..66475f0 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ This project includes comprehensive test coverage for all user-facing functional ``` **42 comprehensive tests** covering: + - One-line installer (help, dry-run, uninstall, error handling) - Shell configuration (aliases, git integration, prompt, key bindings) - Terminal profile (XML validation, color definitions) @@ -52,4 +53,4 @@ See [TROUBLESHOOTING.md](TROUBLESHOOTING.md) for common issues. ## License -MIT Β© Cansin Yildiz \ No newline at end of file +MIT Β© Cansin Yildiz diff --git a/SECURITY.md b/SECURITY.md index 96dfcd6..24533fc 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,16 +2,28 @@ ## Overview -This repository contains personal terminal configuration files (zsh, Terminal profile) and does not ship or execute any application code. As such, it does not have a formal security update or vulnerability management process. +This project provides terminal configuration files (zsh, Terminal profile) with minimal dependencies. Security is maintained through simplicity and transparency. -There are no software dependencies, external services, or executable binaries bundled in this project. +## What This Project Does -## Reporting a Concern +- Installs zsh configuration files to your home directory +- Downloads and installs a Terminal.app profile +- Installs minimal dependencies via Homebrew (lsd, coreutils) +- No network connections during normal operation +- No data collection or external services -If you notice a serious concern affecting the safety, privacy, or integrity of these configuration files, you are welcome to open an issue on the GitHub repository: +## Security Considerations -πŸ”— [yellow-pine/zsh-github-dark Issues](https://github.com/yellow-pine/zsh-github-dark/issues) +The installation script: +- Only modifies files in your home directory +- Backs up existing configurations before changes +- Uses HTTPS for all downloads +- Can be reviewed before execution +- Provides dry-run mode for verification -Please note: -Since this is a static configuration project, no frequent security updates are planned. +## Reporting Security Issues + +For security concerns, please [open an issue](https://github.com/yellow-pine/zsh-github-dark/issues) with details. + +Since this is a configuration project with no runtime components, security updates are rare but will be addressed promptly if needed. diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 3783585..8e5b5a3 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -2,15 +2,15 @@ ## Installation fails -**Problem**: `curl: command not found` +**Problem**: `curl: command not found` **Fix**: Install Xcode Command Line Tools: `xcode-select --install` -**Problem**: `brew: command not found` -**Fix**: Install Homebrew from https://brew.sh +**Problem**: `brew: command not found` +**Fix**: Install Homebrew from ## Prompt looks wrong -**Problem**: No colors or broken characters +**Problem**: No colors or broken characters **Fix**: Set Terminal β†’ Preferences β†’ Profiles β†’ "GitHub Dark" as default ## Command not found: lsd @@ -20,12 +20,14 @@ ## Still having issues? 1. Start fresh: + ```bash rm ~/.zshrc rm -rf ~/.zsh-github-dark ``` 2. Reinstall: + ```bash curl -fsSL https://raw.githubusercontent.com/yellow-pine/zsh-github-dark/main/install.sh | bash - ``` \ No newline at end of file + ```