Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (65 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

76 lines (65 loc) · 2.43 KB

Contributing to Book Library

Thank you for considering contributing to Book Library! We welcome contributions from everyone, and we are grateful for your help in making this project better.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/book-library.git
cd book-library
  3. Install dependencies: 
    composer install
npm install
  4. Set up environment: 
    cp .env.example .env
php artisan key:generate
php artisan migrate

How to Contribute

Reporting Bugs

If you find a bug, please create a new issue with:

  • A clear title and description.
  • Steps to reproduce the issue.
  • Expected vs. actual behavior.
  • Screenshots or logs if applicable.

Suggesting Enhancements

We love new ideas! Verification of the idea's viability is important before you start coding:

  • Check existing issues to see if it's already suggested.
  • Open a discussion or issue to propose your enhancement.

Pull Requests

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/amazing-feature
  2. Make your changes and commit them following our Commit Convention.
  3. Push your branch to GitHub: 
    git push origin feature/amazing-feature
  4. Open a Pull Request (PR) against the main branch.

Style Guide

Please follow the coding standards defined in STYLE_GUIDE.md.

  • PHP: We use Laravel Pint for formatting.
  • JS/CSS: Follow standard conventions.

Commit Convention

We follow the Conventional Commits specification:

  • feat: add new book rating system
  • fix: resolve login validation error
  • docs: update deployment guide
  • chore: update dependencies

License

By contributing, you agree that your contributions will be licensed under its MIT License.