Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (31 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.87 KB
Raw

Contributing to EzAuction

Thank you for your interest in contributing to EzAuction! We welcome contributions from everyone. Please read these guidelines to help us maintain a high-quality, collaborative project.

How to Contribute

1. Reporting Issues

  • Use GitHub Issues to report bugs, request features, or ask questions.
  • Please provide as much detail as possible, including steps to reproduce, logs, and your environment.

2. Submitting Pull Requests

  • Fork the repository and create your branch from main.
  • Follow the existing code style and conventions.
  • Write clear, concise commit messages.
  • Include tests for new features or bug fixes when possible.
  • Ensure your code builds and passes all tests before submitting.
  • Reference related issues in your PR description (e.g., Closes #123).

3. Code Style

  • Use 4 spaces for indentation (Java).
  • Use descriptive names for classes, methods, and variables.
  • Document public classes and methods with Javadoc.
  • Keep gameplay features organized in dedicated packages or classes, following the existing project structure.

4. Documentation

  • Update documentation in the docs/ folder as needed.
  • Add or update code samples and API references if your change affects public APIs.

5. Reviewing and Merging

  • All PRs are reviewed by maintainers.
  • Address review comments promptly.
  • PRs may be squashed and merged for a clean history.

Code of Conduct

This project follows the Contributor Covenant. Be respectful and inclusive in all interactions.

License

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

For any questions, open an issue or contact the maintainers. Thank you for helping make EzAuction better!