Skip to content

Latest commit

 

History

History
118 lines (84 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

118 lines (84 loc) · 3.14 KB

Contributing to Create Nolly CLI

Thank you for your interest in contributing to Create Nolly CLI! 🎉 While this project is primarily developed for my personal use and preferences, I'm happy to share it with the community and welcome suggestions or contributions that align with my vision.

📝 Guidelines for Contributing

🚀 What Contributions Are Welcome?

  • Bug Reports: If you encounter any issues, feel free to open an issue with detailed steps to reproduce the problem.
  • Feature Suggestions: Have an idea for a new feature? Open an issue to propose it!
  • Code Contributions: You can fix bugs, improve performance, or enhance existing features.

Caution

While I’m open to contributions, please understand that I may not accept every suggestion or PR if it doesn’t align with my goals for this project.

🛠️ Setting Up the Project

To get started with the project locally:

  1. Clone the repository:

    git clone https://github.com/thenolle/create-nolly.git
cd create-nolly

  2. Install dependencies:

    pnpm install

  3. Build the project:

    pnpm build

  4. Link the CLI locally:

    pnpm link

  5. Run the CLI:

    create-nolly <project-name>

📦 Submitting a Pull Request (PR)

  1. Fork the repository: Click on the "Fork" button on the top-right of the repository page.

  2. Create a new branch:

    git checkout -b feature/my-awesome-feature

  3. Commit your changes:

    • Follow the project's existing code style.
    • Use meaningful commit messages: 
      git commit -m "feat: add my awesome feature"

  4. Push to your fork:

    git push origin feature/my-awesome-feature

  5. Submit a pull request: Open a PR against the main branch of this repository.

🐛 Reporting Issues

  1. Search existing issues to see if your problem has already been reported.
  2. If not, open a new issue and include:
    • A clear title.
    • Steps to reproduce the issue.
    • Expected vs. actual behavior.
    • Screenshots or logs (if applicable).

🌟 Feature Requests

To propose a new feature:

  1. Open an issue with the title: Feature Request: [Your Feature Name].
  2. Describe your idea clearly:
    • What problem does it solve?
    • How would it work?
    • Why do you think it fits the project?

🚨 Important Notes

[!INFO] This project is primarily for my personal use. I’m happy to share it with others, but please remember:

  • All final decisions on features and contributions are made by me.
  • Contributions that align with my goals and preferences are more likely to be accepted.

Caution

Please respect the scope and goals of this project. Contributions that stray too far from the project's vision may be declined.

❤️ Thank You!

Your contributions—big or small—help make this project even better. Thank you for being a part of the Create Nolly CLI community!

Feel free to reach out via GitHub Issues for questions or discussions.