Creació del Repositori i Organització del Projecte
Per garantir un desenvolupament estructurat i evitar confusions en el futur, he creat un repositori centralitzat organitzat en els següents apartats clau:
- Back-end del Xatbot: Conté la lògica en Python, on es gestiona la connexió amb l’API i el processament de les dades de manera segura.
- Front-end (Integració): Aquí s’allotja el codi HTML i el giny (widget) que permet visualitzar i utilitzar el xatbot directament dins de WordPress.
- Documentació Tècnica: He generat els tres fitxers imprescindibles per a la traçabilitat del projecte:
README.md: Guia general i funcionament del bot.CHANGELOG.md: Registre cronològic de millores i correcció d’errors.CONTRIBUTING.md: Normativa i pautes per a col·laboracions en l’equip.
Aquí tens una versió una mica més tècnica i ben escrita per al teu WordPress, mantenint la senzillesa:
Com hem creat els arxius
Per generar els documents del projecte, hem utilitzat la funció «Add file» > «Create new file» directament des de la interfície de GitHub. Aquest mètode ens ha permès crear els fitxers de documentació (README.md, CHANGELOG.md i CONTRIBUTING.md) i escriure el seu contingut inicial de manera ràpida abans de començar amb el codi.
Procés de configuració i desament
- Definició de l’arxiu: Escrivim el nom del fitxer (per exemple:
README.md). És fonamental incloure correctament l’extensió .md perquè el sistema reconegui el format i apliqui l’estil correcte. - Edició del contingut: En el quadre de text inferior, redactem tota la informació i els detalls de l’apartat corresponent.
- Confirmació de canvis (Commit): Per finalitzar, fem clic al botó de «Commit changes». Aquest pas és clau per assegurar la traçabilitat del projecte i evitar que es perdin els canvis realitzats.
README
CHANGELOG
CONTRIBUTING
