UNPKG

ascii-vibes

Version:

Zero-dep ASCII & Emoji banner generator β€” custom 5x5 font, CLI + API

71 lines (47 loc) β€’ 1.54 kB
# Contributing to ascii-vibes 🎨✨ First off, thank you for checking out **ascii-vibes**! Your contributions β€” whether it’s code, bug fixes, ideas, or documentation improvements β€” are super appreciated. This guide will help you get started quickly. --- ## πŸ›  Getting Started 1. **Fork the repo** to your own GitHub account. 2. **Clone your fork** locally: ```bash git clone https://github.com/DeveloperPuneet/ascii-vibes.git cd ascii-vibes ``` 3. **Install dependencies** (none currently, but good habit): ```bash npm install ``` 4. **Test your changes**: ```bash # Run programmatic tests node test.js # Or try the CLI node bin/ascii-vibes.js "Test Banner" ``` --- ## πŸ’‘ How to Contribute - **Bug reports & issues**: Open an issue on GitHub with clear reproduction steps. - **Feature requests**: Suggest new modes, fonts, emojis, or CLI flags. - **Code contributions**: - Create a new branch: ```bash git checkout -b feature/awesome-new-feature ``` - Make your changes - Test thoroughly - Submit a pull request (PR) with a clear description --- ## πŸ“ Coding Guidelines - Keep code **clean and readable** - Use **descriptive variable names** - Avoid adding unnecessary dependencies - Follow the existing **folder & file structure** --- ## πŸ“£ Communication - Questions, suggestions, or ideas? Contact me at: **developerpuneet2010@gmail.com** --- ## πŸ“œ License By contributing, you agree that your contributions will be licensed under **MIT** (same as this project).