Smernice za poročanje o težavah

Učinkovita poročila o napakah in zahteve po funkcijah so ključnega pomena za razvoj XOOPS. Ta vodnik vam pomaga ustvariti visokokakovostne izdaje.

Pred poročanjem

Preverite obstoječe težave

Vedno išči najprej:

Pojdite na Težave GitHub
Poiščite ključne besede, povezane z vašo težavo
Preverite zaprte težave – morda so že rešene
Poglejte zahteve za vlečenje – morda so v teku

Uporabite iskalne filtre:

is:issue is:open label:bug - Odprti hrošči
is:issue is:open label:feature - Odprite zahteve po funkcijah
is:issue sort:updated - Nedavno posodobljene številke

Je to res težava?

Najprej razmislite o:

Težava s konfiguracijo? - Preverite dokumentacijo
Vprašanje o uporabi? - Vprašajte na forumih ali skupnosti Discord – Varnostna težava? – Oglejte si spodnji razdelek #security-issues
Specifično za modul? - Poročilo vzdrževalcu modula
Posebno za temo? - Poročilo avtorju teme

Vrste težav

Poročilo o napaki

Napaka je nepričakovano vedenje ali napaka.

Primeri:

Prijava ne deluje
Napake v bazi podatkov
Manjka potrditev obrazca
Varnostna ranljivost

Zahteva po funkciji

Zahteva po funkciji je predlog za novo funkcionalnost.

Primeri:

Dodajte podporo za novo funkcijo
Izboljšajte obstoječo funkcionalnost
Dodajte manjkajočo dokumentacijo
Izboljšave zmogljivosti### Izboljšava

Izboljšava izboljša obstoječo funkcionalnost.

Primeri:

Boljša sporočila o napakah
Izboljšana zmogljivost
Boljši API dizajn
Boljša uporabniška izkušnja

Dokumentacija

Težave z dokumentacijo vključujejo manjkajočo ali nepravilno dokumentacijo.

Primeri:

Nepopolna API dokumentacija
Zastareli vodniki
Manjkajoči primeri kode
Tipkarske napake v dokumentaciji

Poročanje o napaki

Predloga poročila o napakah

## Description
Brief, clear description of the bug.

## Steps to Reproduce
1. Step one
2. Step two
3. Step three

## Expected Behavior
What should happen.

## Actual Behavior
What actually happens.

## Environment
- XOOPS Version: X.Y.Z
- PHP Version: 8.2/8.3/8.4
- Database: MySQL/MariaDB version
- Operating System: Windows/macOS/Linux
- Browser: Chrome/Firefox/Safari

## Screenshots
If applicable, add screenshots showing the issue.

## Additional Context
Any other relevant information.

## Possible Fix
If you have suggestions for fixing the issue (optional).

Primer dobrega poročila o napakah

## Description
Login page shows blank page when database connection fails.

## Steps to Reproduce
1. Stop the MySQL service
2. Navigate to the login page
3. Observe the behavior

## Expected Behavior
Show a user-friendly error message explaining the database connection issue.

## Actual Behavior
The page is completely blank - no error message, no interface visible.

## Environment
- XOOPS Version: 2.7.0
- PHP Version: 8.0.28
- Database: MySQL 5.7
- Operating System: Ubuntu 20.04
- Browser: Chrome 120

## Additional Context
This likely affects other pages too. The error should be displayed to admins or logged appropriately.

## Possible Fix
Check database connection in header.php before rendering the template.

Primer slabega poročila o napakah

## Description
Login doesn't work

## Steps to Reproduce
It doesn't work

## Expected Behavior
It should work

## Actual Behavior
It doesn't

## Environment
Latest version

Poročanje o zahtevi za funkcijo

Predloga zahteve za funkcijo

## Description
Clear, concise description of the feature.

## Problem Statement
Why is this feature needed? What problem does it solve?

## Proposed Solution
Describe your ideal implementation or UX.

## Alternatives Considered
Are there other ways to achieve this goal?

## Additional Context
Any mockups, examples, or references.

## Expected Impact
How would this benefit users? Would it be breaking?

Dober primer zahteve za funkcijo

## Description
Add two-factor authentication (2FA) for user accounts.

## Problem Statement
With increasing security breaches, many CMS platforms now offer 2FA. XOOPS users want stronger account security beyond passwords.

## Proposed Solution
Implement TOTP-based 2FA (compatible with Google Authenticator, Authy, etc.).
- Users can enable 2FA in their profile
- Display QR code for setup
- Generate backup codes for recovery
- Require 2FA code at login

## Alternatives Considered
- SMS-based 2FA (requires carrier integration, less secure)
- Hardware keys (too complex for average users)

## Additional Context
Similar to GitHub, GitLab, and WordPress implementations.
Reference: [TOTP Standard RFC 6238](https://tools.ietf.org/html/rfc6238)

## Expected Impact
Increases account security. Could be optional initially, mandatory in future versions.

Varnostne težave

Naredite NOT Javno prijavo

Nikoli ne ustvarjajte javne težave za varnostne ranljivosti.

Prijavi zasebno

Pošljite e-pošto ekipi za varnost: security@XOOPS.org
Vključuje:
- Opis ranljivosti
- Koraki za razmnoževanje
- Možen vpliv
- Vaši kontaktni podatki

Odgovorno razkritje

Prejem bomo potrdili v 48 urah
Posodobitve bomo posredovali vsakih 7 dni
Delali bomo na časovnici popravkov
Lahko zahtevate kredit za odkritje
Usklajevanje časa javne objave

Primer varnostne težave

Subject: [SECURITY] XSS Vulnerability in Comment Form

Description:
The comment form in Publisher module does not properly escape user input,
allowing stored XSS attacks.

Steps to Reproduce:
1. Create a comment with: <img src=x onerror="alert('xss')">
2. Submit the form
3. The JavaScript executes when viewing the comment

Impact:
Attackers can steal user session tokens, perform actions as users,
or deface the website.

Environment:
- XOOPS 2.7.0
- Publisher Module 1.x

Naslov težave Najboljše prakse

Dobri naslovi

✅ Login page shows blank error when database connection fails
✅ Add two-factor authentication support
✅ Form validation not preventing SQL injection in name field
✅ Improve performance of user list query
✅ Update installation documentation for PHP 8.2

Slabi naslovi

❌ Bug in system
❌ Help me!!
❌ It doesn't work
❌ Question about XOOPS
❌ Error

Navodila za naslove

Bodite natančni - Omenite kaj in kje
Bodite jedrnati - Manj kot 75 znakov
Uporabite sedanjik - “prikaže prazno stran” in ne “prikaže prazno”
Vključi kontekst - “v skrbniški plošči”, “med namestitvijo”
Izogibajte se splošnim besedam - Ne “popravi”, “pomoč”, “težava”

Opis težave Najboljše prakse

Vključite bistvene informacije

Kaj – jasen opis težave
Kje – Katera stran, modul ali funkcija
Kdaj – koraki za reprodukcijo
Okolje - različica, OS, brskalnik, PHP
Zakaj – Zakaj je to pomembno

Uporabite oblikovanje kode

Error message: `Error: Cannot find user`

Code snippet:
```php
$user = $this->getUser($id);
if (!$user) {
    echo "Error: Cannot find user";
}

### Include Screenshots

For UI issues, include:
- Screenshot of the problem
- Screenshot of expected behavior
- Annotate what's wrong (arrows, circles)

### Use Labels

Add labels to categorize:
- `bug` - Bug report
- `enhancement` - Enhancement request
- `documentation` - Documentation issue
- `help wanted` - Looking for help
- `good first issue` - Good for new contributors

---

## After Reporting

### Be Responsive

- Check for questions in the issue comments
- Provide additional information if requested
- Test suggested fixes
- Verify bug still exists with new versions

### Follow Etiquette

- Be respectful and professional
- Assume good intentions
- Don't demand fixes - developers are volunteers
- Offer to help if possible
- Thank contributors for their work

### Keep Issue Focused

- Stay on topic
- Don't discuss unrelated issues
- Link to related issues instead
- Don't use issues for feature voting

---

## What Happens to Issues

### Triage Process

1. **New issue created** - GitHub notifies maintainers
2. **Initial review** - Checked for clarity and duplicates
3. **Label assignment** - Categorized and prioritized
4. **Assignment** - Assigned to someone if appropriate
5. **Discussion** - Additional info gathered if needed

### Priority Levels

- **Critical** - Data loss, security, complete breakage
- **High** - Major feature broken, affects many users
- **Medium** - Part of feature broken, workaround available
- **Low** - Minor issue, cosmetic, or niche use case

### Resolution Outcomes

- **Fixed** - Issue resolved in a PR
- **Won't fix** - Rejected for technical or strategic reasons
- **Duplicate** - Same as another issue
- **Invalid** - Not actually an issue
- **Needs more info** - Waiting for additional details

---

## Issue Examples

### Example: Good Bug Report

```markdown
## Description
Admin users cannot delete items when using MySQL with strict mode enabled.

## Steps to Reproduce
1. Enable `sql_mode='STRICT_TRANS_TABLES'` in MySQL
2. Navigate to Publisher admin panel
3. Click delete button on any article
4. Error is shown

## Expected Behavior
Article should be deleted or show meaningful error.

## Actual Behavior
Error: "SQL Error - Unknown column 'deleted_at' in ON clause"

## Environment
- XOOPS Version: 2.7.0
- PHP Version: 8.2.0
- Database: MySQL 8.0.32 with STRICT_TRANS_TABLES
- Operating System: Ubuntu 22.04
- Browser: Firefox 120

## Screenshots
[Screenshot of error message]

## Additional Context
This only happens with strict SQL mode. Works fine with default settings.
The query is in class/PublisherItem.php:248

## Possible Fix
Use single quotes around 'deleted_at' or use backticks for all column names.

Primer: Zahteva za dobro funkcijo

## Description
Add REST API endpoints for read-only access to public content.

## Problem Statement
Developers want to build mobile apps and external services using XOOPS data.
Currently limited to SOAP API which is outdated and poorly documented.

## Proposed Solution
Implement RESTful API with:
- Endpoints for articles, users, comments (read-only)
- Token-based authentication
- Standard HTTP status codes and errors
- OpenAPI/Swagger documentation
- Pagination support

## Alternatives Considered
- Enhanced SOAP API (legacy, not standards-compliant)
- GraphQL (more complex, maybe future)

## Additional Context
See Publisher module API refactoring for similar patterns.
Would align with modern web development practices.

## Expected Impact
Enable ecosystem of third-party tools and mobile apps.
Would improve XOOPS adoption and ecosystem.

Povezana dokumentacija

Kodeks ravnanja
Potek dela prispevka
Smernice za zahtevo po vleku
Pregled prispevka

#XOOPS #issues #bug-reporting #feature-requests #github