diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..b8727eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug Report +about: Report a bug to help us improve +title: '[BUG] ' +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear description of what the bug is. + +**To Reproduce** +1. Go to '...' +2. Click on '...' +3. See error + +**Expected behavior** +What you expected to happen. + +**Screenshots** +If applicable, add screenshots. + +**Environment:** +- Device: [e.g. iPhone 15, Desktop] +- Browser: [e.g. Safari, Chrome] +- Version: [e.g. 1.0.0] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a805135 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature Request +about: Suggest a new feature +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem?** +A clear description of the problem. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear description of what you want to happen. + +**Additional context** +Any mockups, screenshots, or examples from other apps. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4c41269 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing to Bookoholik + +Thank you for your interest in contributing! 🎉 + +## How to Contribute + +### Reporting Bugs +- Open an issue with the "bug" label +- Include screenshots, browser info, and steps to reproduce + +### Suggesting Features +- Open an issue with the "enhancement" label +- Describe the use case and expected behavior + +### Code Contributions + +1. Fork the repository +2. Create a feature branch: `git checkout -b feature/my-feature` +3. Make your changes +4. Test locally with `podman compose up -d --build` +5. Commit with clear messages: `git commit -m "feat: add book rating system"` +6. Push and open a Pull Request + +### Development Setup + +```bash +git clone https://github.com/YOUR_ORG/home-library.git +cd home-library +cp .env.example .env +# Edit .env with your settings +podman compose up -d --build +# App at http://localhost:3000 +``` + +### Code Style +- PHP: PSR-12 +- JavaScript/Vue: Standard + Vue recommended rules +- Commits: [Conventional Commits](https://www.conventionalcommits.org/) + +### Translation Help +We welcome translations! Files are in `frontend/src/i18n/`: +- Copy `en.js` → `xx.js` (your language code) +- Translate all strings +- Register in `frontend/src/i18n/index.js` + +## Code of Conduct +Be respectful, inclusive, and constructive. We're all here to build something useful together. diff --git a/README.md b/README.md index 3a9afcd..88bb9a9 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,10 @@ A modern, multilingual web application for managing your personal home library. ![PHP](https://img.shields.io/badge/PHP-8.3-777BB4?logo=php&logoColor=white) ![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16-4169E1?logo=postgresql&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-Compose-2496ED?logo=docker&logoColor=white) - +[![GitHub stars](https://img.shields.io/github/stars/XKlibure/home-library?style=social)](https://github.com/XKlibure/home-library) +[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) +[![Docker](https://img.shields.io/badge/Docker-Ready-blue?logo=docker)](docker-compose.yml) +[![SonarCloud](https://sonarcloud.io/api/project_badges/measure?project=bookoholik&metric=alert_status)](https://sonarcloud.io/dashboard?id=bookoholik) --- ## ✨ Features