Skip to content

Contributing Guide

Thank you for considering contributing to our Java Projects! This document provides guidelines and instructions for contributors.

Getting Started

  1. Fork the repository
  2. Clone your fork:
bash
git clone https://github.com/YOUR-USERNAME/javaprojects.git

Development Setup

  1. Install prerequisites:

    • Java Development Kit (JDK) 11 or later
    • Git
    • Your favorite IDE
  2. Build the project:

bash
./gradlew build

Coding Standards

Java Code Style

  • Use 4 spaces for indentation
  • Follow Java naming conventions
  • Add comments for complex logic
  • Write unit tests for new features

Pull Request Process

  1. Create a new branch:
bash
git checkout -b feature/your-feature-name
  1. Make your changes
  2. Write tests
  3. Update documentation
  4. Submit a pull request

Before Submitting

  • Ensure all tests pass
  • Update relevant documentation
  • Follow the code style guidelines

Need Help?

Feel free to:

  • Open an issue
  • Ask questions in discussions
  • Contact the maintainers

Built with Java ☕