Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (45 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.82 KB

Contributing to FunnyQuoteLib

Thank you for considering contributing to FunnyQuoteLib! We welcome your help in making this project better. Please take a moment to review the following guidelines to ensure a smooth contribution process.

Ways to Contribute

There are several ways to contribute to FunnyQuoteLib:

  1. Bug Reports:

    • Encountered a bug or unexpected behavior? Open an issue on GitHub. Provide a detailed description, steps to reproduce, and information about your environment.

  2. Feature Requests:

    • Have an idea for a new feature or improvement? Submit a feature request on GitHub. We welcome your feedback and creativity.

  3. Code Contributions:

    • Interested in contributing code? Follow these steps:
      • Fork the repository.
      • Create a new branch for your feature or bug fix.
      • Make your changes and submit a pull request (PR) to the main branch.

  4. Propose New Quotes:

    • Help enrich our collection of quotes by submitting pull requests with new and funny quotes. Follow these guidelines:
      • Ensure that the quote is genuinely humorous and aligns with the tone of FunnyQuoteLib.
      • Include the quote along with any relevant attribution or context.
      • Verify that the quote adheres to copyright and licensing requirements.
      • Please target the quotes-submissions branch when submitting your pull request.

We appreciate your contribution in making FunnyQuoteLib a source of laughter and joy!

  1. Documentation Improvements:
    • Enhance our documentation by submitting pull requests for clarifications, corrections, or additional information.

We appreciate and welcome contributions from the community to make FunnyQuoteLib even more entertaining and enjoyable!

Development Setup

To set up FunnyQuoteLi for development:

  1. Clone your fork of the repository: 
    git clone https://github.com/olarno/funnyQuoteLibrary.git
  2. Install dependencies using Composer: 
    composer install
  3. Make your changes and test thoroughly.

Code Style

Please follow the coding standards and conventions outlined in the Coding Guidelines to maintain a consistent codebase.

Code Reviews

All contributions undergo a review process. Be prepared to address feedback and iterate on your changes.

Community Guidelines

Be respectful and considerate of others. Follow the Code of Conduct. Engage in constructive discussions and provide feedback to fellow contributors.

Attribution

By contributing to FunnyQuoteLi, you agree that your contributions will be licensed under the MIT License.

We appreciate your contributions and look forward to building an even more amazing project together!