Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (42 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 1.28 KB

Contributing to skelecli

Thank you for considering contributing to Blueprint CLI! We welcome all contributions to improve this project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/SkeleCLI.git
  3. Install dependencies using pnpm (preferred): 
    pnpm install
  4. Create a new branch for your contribution: 
    git checkout -b feature/your-feature-name

How to Contribute

  • Add new templates: Place your project templates in the templates/ directory.
  • Enhance the CLI: Modify skelecli.js and related files to add new features.
  • Improve Documentation: Update README.md and CONTRIBUTING.md.

Code Guidelines

  • Follow the existing code style.
  • Use modern JavaScript (ESM, async/await).
  • Run tests before submitting: 
    pnpm test

Submitting Changes

  1. Commit your changes: 
    git add .
git commit -m "feat: add new feature"
  2. Push to your fork: 
    git push origin feature/your-feature-name
  3. Open a Pull Request on GitHub.

Issues and Feedback

  • Report issues via GitHub Issues.
  • Suggest new features or improvements.

Thank you for contributing! 🚀