Skip to content

Latest commit

 

History

History
140 lines (99 loc) · 6.53 KB

CONTRIBUTING.md

File metadata and controls

140 lines (99 loc) · 6.53 KB
Raw

Contributing to JBriscola

First off, thank you for considering contributing to JBriscola! It's people like you that make it possible for this project to exist and improve.

Index

  1. English

  2. Italiano

🇬🇧

Code of Conduct

This project and everyone participating in it is governed by the JBriscola Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

Reporting Bugs

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Suggesting Enhancements

If you have an idea to improve JBriscola, that's great! Please check the issues list first to see if your suggestion has already been discussed. If not, feel free to submit a new issue with your enhancement suggestion.

Submitting Code

We are always open to code contributions. If you are new to open source or need some guidance, check out the Pull Requests section below for detailed instructions.

Getting Started

  • Fork the repository on GitHub.
  • Clone your fork to your local machine:
  • Make your changes.
  • Commit your changes with a clear message
  • Create a new Pull Request on GitHub

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Pull Requests

Process

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md or other documentation if necessary.
  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  • Once approved, your pull request will be merged and you will be listed as a contributor.

Guidelines

  • Make sure your code follows our Coding Standards.
  • Write clear, concise commit messages.
  • Test your code thoroughly.
  • Keep your Pull Requests small and focused.

Coding Standards

  • Follow the Java coding standards and best practices.
  • Use meaningful variable and function names.
  • Maintain consistent indentation and formatting.
  • Include comments and documentation where necessary.

Feature Requests

Feature requests are welcome! If you have a feature request, please first check if it is already listed in the issues. If not, feel free to create a new issue with a detailed description of the feature you want to see.

#License By contributing to JBriscola, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!

🇮🇹

Code of Conduct

Questo progetto e tutti coloro che vi partecipano sono regolati dal Codice di condotta di JBriscola. Partecipando, sei tenuto a sostenere questo codice.

Come contribuire

Segnalazione di bug

Se trovi un bug nel codice sorgente o un errore nella documentazione, puoi aiutarci segnalando un problema al nostro GitHub Repository. Ancora meglio, puoi inviare una pull request con una correzione.

Suggerire miglioramenti

Se hai un'idea per migliorare JBriscola, è fantastico! Controlla prima l'elenco dei problemi per vedere se il tuo suggerimento è già stato discusso. In caso contrario, sentiti libero di inviare un nuovo problema con il tuo suggerimento di miglioramento.

Invio del codice

Siamo sempre aperti a contributi di codice. Se sei nuovo all'open source o hai bisogno di indicazioni, consulta la sezione Richieste Pull di seguito per istruzioni dettagliate.

Per iniziare

  • Effettua il fork del repository su GitHub.
  • Clona il tuo fork sul tuo computer locale:
  • Apporta le tue modifiche.
  • Applica le tue modifiche con un messaggio chiaro
  • Crea una nuova richiesta pull su GitHub

Issues

Utilizziamo i problemi di GitHub per tenere traccia dei bug pubblici. Assicurati che la descrizione sia chiara e contenga istruzioni sufficienti per poter riprodurre il problema.

Pull Requests

Processo

  • Assicurarsi che eventuali dipendenze di installazione o compilazione vengano rimosse prima della fine del livello durante l'esecuzione di una compilazione.
  • Aggiorna README.md o altra documentazione se necessario.
  • Aumentare i numeri di versione in tutti i file di esempio e README.md alla nuova versione che questa richiesta pull rappresenterebbe.
  • Una volta approvata, la tua richiesta pull verrà unita e verrai elencato come collaboratore.

Linee guida

  • Assicurati che il tuo codice segua i nostri Standard di codifica.
  • Scrivi messaggi di commit chiari e concisi.
  • Testa accuratamente il tuo codice.
  • Mantieni le tue richieste pull piccole e mirate.

Coding Standards

  • Seguire gli standard e le migliori pratiche di codifica Java.
  • Utilizzare nomi di variabili e funzioni significativi.
  • Mantenere rientro e formattazione coerenti.
  • Includere commenti e documentazione ove necessario.

Feature Requests

Le richieste di funzionalità sono benvenute! Se hai una richiesta di funzionalità, controlla prima se è già elencata nei problemi. In caso contrario, sentiti libero di creare un nuovo problema con una descrizione dettagliata della funzionalità che desideri vedere.

#License Contribuendo a JBriscola, accetti che i tuoi contributi saranno concessi in licenza sotto la Licenza MIT.

Grazie per i tuoi contributi!