Skip to content

Latest commit

 

History

History
102 lines (78 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

102 lines (78 loc) · 3.68 KB

Contributing to Minimalist Prompt Generator

Thank you for your interest in contributing to Minimalist Prompt Generator! We appreciate your help and are excited to collaborate with you. Please follow the guidelines below to ensure a smooth contribution process.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Setup
  4. Style Guide
  5. Submitting a Pull Request
  6. Feedback

Code of Conduct

Please read our Code of Conduct to understand the behavior we expect from contributors.

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue and include as much detail as possible. Make sure to include:

  • Steps to reproduce the bug
  • Expected and actual behavior
  • Any relevant screenshots, error messages, or logs

Suggesting Features

We welcome suggestions to improve the project! To suggest a feature:

  1. Create an issue titled "Feature Request: [Your Feature Title]"
  2. Explain the feature in detail, including the use case and potential benefits.
  3. Add any mockups, diagrams, or additional context if available.

Improving Documentation

We appreciate help with making our documentation clearer and more comprehensive. You can contribute by:

  • Fixing typos or clarifying instructions
  • Adding examples to the documentation
  • Updating outdated sections as the project evolves

Contributing Code

If you’d like to contribute code:

  1. Check existing issues to see if there’s an open discussion about your idea.
  2. If there isn’t, feel free to open a new issue to discuss it with the maintainers.
  3. After discussion, start working on your changes.

Development Setup

  1. Fork the repository and clone it locally.

    git clone https://github.com/your-username/MinimalistPromptGenerator.git

  2. Install dependencies (ensure you have Node.js installed).

    npm install

  3. Start the development server.

    npm run dev

  4. Run tests (if applicable).

    npm test

Please make sure all tests pass before submitting a pull request.

Style Guide

  • Code Quality: Run eslint and prettier (if configured) to maintain code quality.
  • File Naming: Use consistent, descriptive names for files.
  • Commits: Write clear, concise commit messages. Use conventional commit style if possible (e.g., feat: add new feature, fix: resolve issue with...).
  • Comments: Add comments where necessary, especially for complex code.

Submitting a Pull Request

  1. Create a branch from main:

    git checkout -b feature/your-feature-name

  2. Make your changes and commit with a clear, concise message.

  3. Push your branch to GitHub:

    git push origin feature/your-feature-name

  4. Submit a pull request:

    • Go to the Pull Requests section on GitHub.
    • Select your branch and open a pull request against main.
    • Include a brief description of your changes and link any relevant issues.

Feedback

Your contributions are valued, and we aim to provide feedback as quickly as possible. If you don’t hear back within a week, feel free to ping us on the PR or issue.

Thank you for helping improve Minimalist Prompt Generator! Happy coding!