From dedc660897510394ab2023e6f76b6b8e15d94857 Mon Sep 17 00:00:00 2001 From: Antonio Musarra Date: Tue, 16 Apr 2024 10:11:50 +0200 Subject: [PATCH] Aggiunto il file di CHANGELOG.md e CONTRIBUTING.md --- CHANGELOG.md | 24 +++++++++++++++++++ CONTRIBUTING.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6a6f200 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,24 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- This CHANGELOG file to hopefully serve as an evolving example of a + standardized open source project CHANGELOG. +- Guidelines for contributing to this repository. + +### Changed + +### Removed + +### Deprecated + +### Security + +## [1.0.0] - 2024-01-01 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..45953aa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ +Certamente! Ecco una guida specifica per contribuire al tuo progetto GitHub "Event Bus Logging JAX-RS": + +### Guida per Contribuire a Event Bus Logging JAX-RS + +#### 1. **Scegliere un Problema o una Funzionalità da Implementare** + +Esamina la lista degli issues aperti sul repository del progetto. Cerca un +problema che ti interessi o una funzionalità che ritieni utile aggiungere. + +Potresti voler implementare una nuova funzionalità, risolvere un bug +esistente o migliorare la documentazione. + +#### 2. **Fare il Fork del Repository** + +Fai il fork del repository "Event Bus Logging JAX-RS" sul tuo account GitHub. +Questo ti permette di lavorare sul tuo fork senza influenzare il repository originale. + +#### 3. **Configurare l'Ambiente di Sviluppo** + +Assicurati di avere tutte le dipendenze necessarie per il progetto installate +nel tuo ambiente di sviluppo. Consulta il file README del progetto per istruzioni +dettagliate su come configurare l'ambiente. + +#### 4. **Lavorare sul Problema Selezionato** + +Una volta scelto il problema o la funzionalità da affrontare, crea un nuovo +branch nel tuo fork del repository e inizia a lavorare su di esso. +Assicurati di seguire le linee guida di codifica del progetto e di scrivere +codice pulito e ben documentato. + +#### 5. **Testare i Cambiamenti Localmente** + +Prima di inviare una richiesta di pull, assicurati di testare i tuoi cambiamenti +localmente. Esegui tutti i test esistenti per assicurarti che il tuo codice +funzioni correttamente e che non abbia introdotto nuovi bug. + +#### 6. **Invia una Richiesta di Pull** + +Una volta soddisfatto dei tuoi cambiamenti e dei test eseguiti, invia una richiesta +di pull al repository originale. Assicurati di descrivere chiaramente i cambiamenti +apportati e il motivo per cui dovrebbero essere accettati. + +#### 7. **Partecipare alla Discussione** + +Dopo aver inviato la richiesta di pull, potrebbe essere necessario partecipare a +una discussione con gli altri contributori e i maintainer del progetto. +Rispondi alle domande e fai le modifiche richieste, se necessario. + +#### 8. **Attendere la Revisione e l'Approvazione** + +Dopo aver inviato la richiesta di pull, i maintainer del progetto esamineranno +il tuo codice. Potrebbero richiederti ulteriori modifiche o suggerirti miglioramenti. +Assicurati di essere disponibile per apportare eventuali cambiamenti richiesti. + +#### 9. **Celebra la Tua Contribuzione!** + +Una volta che la tua richiesta di pull è stata accettata e il tuo codice è stato +incluso nel progetto, festeggia! Hai appena contribuito al progetto +"Event Bus Logging JAX-RS" e hai reso migliore il software per tutti gli utenti. +Continua a contribuire e a fare la differenza nella comunità open source! + +Seguendo questa guida, potrai contribuire con successo al progetto +"Event Bus Logging JAX-RS" e far parte della sua comunità di sviluppatori. +Buona fortuna! \ No newline at end of file