First off, thank you for considering contributing to this project! Your contributions are greatly appreciated. / Zunächst einmal vielen Dank, dass Sie in Erwägung ziehen, zu diesem Projekt beizutragen! Ihre Beiträge sind sehr willkommen.
Here are some guidelines to follow when contributing. / Hier sind einige Richtlinien, die beim Beitragen beachtet werden sollten.
If you find a bug, please report it by creating an issue in the GitHub repository. Include as much detail as possible to help in diagnosing and fixing the issue quickly:
- A clear and descriptive title.
- A detailed description of the steps to reproduce the issue.
- Any relevant logs or screenshots.
- The version of ELiquidCalculator you are using.
Enhancement suggestions are welcome! If you have an idea to improve the project, please create an issue in the GitHub repository with the tag "enhancement" and provide a detailed description of your suggestion:
- A clear and descriptive title.
- A detailed description of the enhancement and why it would be useful.
- Any relevant examples or mockups.
Pull requests are welcome! To ensure a smooth process, please follow these steps:
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure your code passes the tests.
- Make sure your code lints.
- Submit your pull request.
- Your pull request will be reviewed by the project maintainer.
- Ensure that all tests pass and that your code meets the project's coding standards.
- The pull request will run through a local CI/CD pipeline. If it passes all checks and is approved, it will be merged into the main branch.
- Depending on the nature of the changes, the pull request may either be directly merged into GitHub or first merged into the local project and then pushed to GitHub with a reference to the pull request.
All pull requests will run through a local pipeline that includes building, testing, and other checks to ensure code quality and functionality. Only pull requests that pass this pipeline will be considered for merging.
Please follow the existing code style in the project. Adhering to a consistent style helps ensure that the code base is easy to read, maintain, and understand. The code style mainly follows the Google Java Style Guide. Try to avoid comments and Javadoc. Instead, use meaningful names for methods and variables.
If you need to get in touch, you can contact the project maintainer through GitHub discussions or create an issue.
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
Thank you for your contributions!
Wenn Sie einen Fehler finden, melden Sie ihn bitte, indem Sie ein Issue im GitHub-Repository erstellen. Geben Sie so viele Details wie möglich an, um bei der Diagnose und schnellen Behebung des Problems zu helfen:
- Ein klarer und beschreibender Titel.
- Eine detaillierte Beschreibung der Schritte, um den Fehler zu reproduzieren.
- Alle relevanten Protokolle oder Screenshots.
- Die verwendete Version von ELiquidCalculator.
Vorschläge zur Verbesserung sind willkommen! Wenn Sie eine Idee haben, um das Projekt zu verbessern, erstellen Sie bitte ein Issue im GitHub-Repository mit dem Tag "enhancement" und geben Sie eine detaillierte Beschreibung Ihres Vorschlags an:
- Ein klarer und beschreibender Titel.
- Eine detaillierte Beschreibung der Verbesserung und warum sie nützlich wäre.
- Alle relevanten Beispiele oder Mockups.
Pull-Requests sind willkommen! Um einen reibungslosen Ablauf zu gewährleisten, befolgen Sie bitte diese Schritte:
- Forken Sie das Repository und erstellen Sie Ihren Branch ausgehend von
main. - Wenn Sie Code hinzugefügt haben, der getestet werden sollte, fügen Sie Tests hinzu.
- Wenn Sie APIs geändert haben, aktualisieren Sie die Dokumentation.
- Stellen Sie sicher, dass Ihr Code die Tests besteht.
- Achten Sie darauf, dass Ihr Code den Linter besteht.
- Reichen Sie Ihren Pull-Request ein.
- Ihr Pull-Request wird vom Projektbetreuer überprüft.
- Stellen Sie sicher, dass alle Tests bestanden werden und Ihr Code den Coding-Standards des Projekts entspricht.
- Der Pull-Request wird durch eine lokale CI/CD-Pipeline ausgeführt. Wenn er alle Überprüfungen besteht und genehmigt wird, wird er in den Hauptbranch integriert.
- Abhängig von der Art der Änderungen kann der Pull-Request entweder direkt in GitHub zusammengeführt oder zunächst in das lokale Projekt integriert und dann mit einem Verweis auf den Pull-Request nach GitHub gepusht werden.
Alle Pull-Requests werden durch eine lokale Pipeline ausgeführt, die das Bauen, Testen und andere Überprüfungen zur Sicherstellung der Codequalität und Funktionalität umfasst. Nur Pull-Requests, die diese Pipeline bestehen, werden zur Zusammenführung in Betracht gezogen.
Bitte folgen Sie dem bestehenden Code-Stil im Projekt. Die Einhaltung eines konsistenten Stils hilft sicherzustellen, dass der Code leicht zu lesen, zu warten und zu verstehen ist. Der Code-Stil folgt hauptsächlich dem Google Java Style Guide. Versuchen Sie, Kommentare und Javadoc zu vermeiden. Verwenden Sie stattdessen aussagekräftige Namen für Methoden und Variablen.
Wenn Sie Kontakt aufnehmen müssen, können Sie den Projektbetreuer über GitHub-Diskussionen kontaktieren oder ein Issue erstellen.
Durch Ihren Beitrag zu diesem Projekt stimmen Sie zu, dass Ihre Beiträge unter derselben Lizenz wie das Projekt lizenziert werden.
Bitte beachten Sie, dass dieses Projekt mit einem Contributor Code of Conduct veröffentlicht wird. Durch die Teilnahme an diesem Projekt erklären Sie sich bereit, die Bedingungen einzuhalten.
Vielen Dank für Ihre Beiträge!