Skip to content

Commit 3647f51

Browse files
authored
Merge pull request #3 from Excalibure86/main
Update README file
2 parents a16798a + 868c648 commit 3647f51

4 files changed

Lines changed: 93 additions & 1 deletion

File tree

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear description of what the bug is.
11+
12+
**To Reproduce**
13+
1. Go to '...'
14+
2. Click on '...'
15+
3. See error
16+
17+
**Expected behavior**
18+
What you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots.
22+
23+
**Environment:**
24+
- Device: [e.g. iPhone 15, Desktop]
25+
- Browser: [e.g. Safari, Chrome]
26+
- Version: [e.g. 1.0.0]
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem?**
10+
A clear description of the problem. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear description of what you want to happen.
14+
15+
**Additional context**
16+
Any mockups, screenshots, or examples from other apps.

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to Bookoholik
2+
3+
Thank you for your interest in contributing! 🎉
4+
5+
## How to Contribute
6+
7+
### Reporting Bugs
8+
- Open an issue with the "bug" label
9+
- Include screenshots, browser info, and steps to reproduce
10+
11+
### Suggesting Features
12+
- Open an issue with the "enhancement" label
13+
- Describe the use case and expected behavior
14+
15+
### Code Contributions
16+
17+
1. Fork the repository
18+
2. Create a feature branch: `git checkout -b feature/my-feature`
19+
3. Make your changes
20+
4. Test locally with `podman compose up -d --build`
21+
5. Commit with clear messages: `git commit -m "feat: add book rating system"`
22+
6. Push and open a Pull Request
23+
24+
### Development Setup
25+
26+
```bash
27+
git clone https://github.com/YOUR_ORG/home-library.git
28+
cd home-library
29+
cp .env.example .env
30+
# Edit .env with your settings
31+
podman compose up -d --build
32+
# App at http://localhost:3000
33+
```
34+
35+
### Code Style
36+
- PHP: PSR-12
37+
- JavaScript/Vue: Standard + Vue recommended rules
38+
- Commits: [Conventional Commits](https://www.conventionalcommits.org/)
39+
40+
### Translation Help
41+
We welcome translations! Files are in `frontend/src/i18n/`:
42+
- Copy `en.js``xx.js` (your language code)
43+
- Translate all strings
44+
- Register in `frontend/src/i18n/index.js`
45+
46+
## Code of Conduct
47+
Be respectful, inclusive, and constructive. We're all here to build something useful together.

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ A modern, multilingual web application for managing your personal home library.
66
![PHP](https://img.shields.io/badge/PHP-8.3-777BB4?logo=php&logoColor=white)
77
![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16-4169E1?logo=postgresql&logoColor=white)
88
![Docker](https://img.shields.io/badge/Docker-Compose-2496ED?logo=docker&logoColor=white)
9-
9+
[![GitHub stars](https://img.shields.io/github/stars/XKlibure/home-library?style=social)](https://github.com/XKlibure/home-library)
10+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
11+
[![Docker](https://img.shields.io/badge/Docker-Ready-blue?logo=docker)](docker-compose.yml)
12+
[![SonarCloud](https://sonarcloud.io/api/project_badges/measure?project=bookoholik&metric=alert_status)](https://sonarcloud.io/dashboard?id=bookoholik)
1013
---
1114

1215
## ✨ Features

0 commit comments

Comments
 (0)