|
| 1 | +# Bidra till sfs-processor |
| 2 | + |
| 3 | +Tack för ditt intresse att bidra till sfs-processor! Det här dokumentet beskriver hur du kan hjälpa till. |
| 4 | + |
| 5 | +## Snabbstart |
| 6 | + |
| 7 | +1. **Forka och klona** repositoryt |
| 8 | +2. **Installera**: `pip install -r requirements.txt` |
| 9 | +3. **Testa**: `python -m pytest test/ -v` |
| 10 | +4. **Läs**: [DEVELOPMENT.md](DEVELOPMENT.md) för teknisk dokumentation |
| 11 | + |
| 12 | +För detaljerad setup och utvecklingsmiljö, se [DEVELOPMENT.md](DEVELOPMENT.md). |
| 13 | + |
| 14 | +## Bidra med kod |
| 15 | + |
| 16 | +### Arbetsflöde |
| 17 | + |
| 18 | +1. Skapa en feature branch från `main`: |
| 19 | + ```bash |
| 20 | + git checkout -b feature/min-funktion |
| 21 | + ``` |
| 22 | + |
| 23 | + Använd beskrivande branch-namn: |
| 24 | + - `feature/` för nya funktioner |
| 25 | + - `fix/` för buggfixar |
| 26 | + |
| 27 | +2. Gör dina ändringar och commit: |
| 28 | + ```bash |
| 29 | + git add . |
| 30 | + git commit -m "Beskrivande commit-meddelande" |
| 31 | + ``` |
| 32 | + |
| 33 | + Skriv tydliga commit-meddelanden som förklarar *vad* och *varför*. |
| 34 | + |
| 35 | +3. Pusha till din fork: |
| 36 | + ```bash |
| 37 | + git push origin feature/min-funktion |
| 38 | + ``` |
| 39 | + |
| 40 | +4. Öppna en Pull Request på GitHub |
| 41 | + |
| 42 | +### Pull Request-process |
| 43 | + |
| 44 | +När du öppnar en Pull Request: |
| 45 | + |
| 46 | +- **Beskriv dina ändringar**: Förklara vad din PR gör och varför ändringen behövs |
| 47 | +- **Referera till issues**: Om din PR löser ett issue, länka till det (t.ex. "Fixes #123") |
| 48 | +- **Inkludera tester**: Lägg till tester för nya funktioner eller buggfixar |
| 49 | +- **Se till att tester passerar**: Alla befintliga tester måste fortfarande fungera |
| 50 | +- **Uppdatera dokumentation**: Om du ändrar funktionalitet, uppdatera README eller andra relevanta dokument |
| 51 | + |
| 52 | +Vi kommer att granska din PR och ge feedback. Var beredd på att göra ändringar baserat på code review. |
| 53 | + |
| 54 | +## Rapportera buggar |
| 55 | + |
| 56 | +Hittat en bugg? Hjälp oss att fixa den! |
| 57 | + |
| 58 | +1. **Kontrollera befintliga issues**: Kolla om någon redan rapporterat samma problem |
| 59 | +2. **Öppna ett nytt issue** med följande information: |
| 60 | + - **Tydlig titel**: Sammanfatta problemet kortfattat |
| 61 | + - **Beskrivning**: Beskriv vad som händer och vad du förväntade dig |
| 62 | + - **Reproducerbarhet**: Steg för att återskapa problemet |
| 63 | + - **Miljö**: Python-version, operativsystem |
| 64 | + - **Exempel**: Minimal kod eller kommando som visar problemet |
| 65 | + - **Felmeddelanden**: Inkludera fullständiga stack traces om tillämpligt |
| 66 | + |
| 67 | +### Exempel på buggrapport |
| 68 | + |
| 69 | +```markdown |
| 70 | +## Titel: Fel vid parsing av dokument med tomma kapitel |
| 71 | + |
| 72 | +**Beskrivning:** |
| 73 | +När sfs_processor.py försöker processa ett SFS-dokument som innehåller tomma kapitel |
| 74 | +kraschar programmet med ValueError. |
| 75 | + |
| 76 | +**Steg för att reproducera:** |
| 77 | +1. Ladda ner SFS 2023:123 |
| 78 | +2. Kör: `python sfs_processor.py sfs_json/2023/sfs-2023-123.json --output md` |
| 79 | + |
| 80 | +**Förväntat resultat:** |
| 81 | +Dokumentet processas korrekt och tomma kapitel ignoreras. |
| 82 | + |
| 83 | +**Faktiskt resultat:** |
| 84 | +``` |
| 85 | +ValueError: Cannot process empty chapter |
| 86 | +``` |
| 87 | +
|
| 88 | +**Miljö:** |
| 89 | +- Python 3.11.4 |
| 90 | +- macOS Sonoma 14.2 |
| 91 | +- sfs-processor version 1.0.0 |
| 92 | +``` |
| 93 | + |
| 94 | +## Kodstandard |
| 95 | + |
| 96 | +Projektet följer **PEP 8-standarden**. Huvudriktlinjer: |
| 97 | + |
| 98 | +- 4 mellanslag för indentering |
| 99 | +- Max 100 tecken per rad |
| 100 | +- Beskrivande variabelnamn |
| 101 | +- Docstrings för alla publika funktioner |
| 102 | + |
| 103 | +För fullständiga kodkonventioner, se [DEVELOPMENT.md](DEVELOPMENT.md#kodkonventioner). |
| 104 | + |
| 105 | +## Frågor? |
| 106 | + |
| 107 | +Om du har frågor som inte täcks här: |
| 108 | + |
| 109 | +- Öppna ett issue med etiketten "question" |
| 110 | +- Kontakta Martin Rimskog via [e-post](mailto:martin@marca.se) [LinkedIn](https://www.linkedin.com/in/martinrimskog/) |
| 111 | + |
| 112 | +Tack för ditt bidrag! 🙏 |
0 commit comments