Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (59 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

86 lines (59 loc) · 2.87 KB

Contributing to AutoBucket

Thank you for considering contributing to AutoBucket! Your contributions help improve the project, and we appreciate your efforts.

Table of Contents

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

Reporting Bugs

If you encounter any bugs, please open an issue in the GitHub repository. Be sure to include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Your environment details (e.g., OS, Java version, etc.).
  • Any error messages or logs.

Suggesting Enhancements

We welcome suggestions to improve AutoBucket! To suggest an enhancement:

  1. Check if there is an existing issue for your suggestion.
  2. If not, open a new issue with the following details:
    • A descriptive title.
    • A detailed description of the enhancement.
    • Any relevant context or screenshots.

Submitting Pull Requests

To submit a pull request:

  1. Fork the repository.

  2. Create a new branch from main (e.g., feature/my-new-feature).

  3. Make your changes in the new branch.

  4. Test your changes thoroughly.

  5. Commit your changes with a descriptive message.

  6. Push your changes to your fork.

  7. Open a pull request in the original repository.

    • Ensure you fill out the Pull Request Template provided, which will guide you through the required information.
    • Your pull request will be reviewed by the maintainers. Please be patient, as it may take some time to receive feedback.

Development Setup

To set up your development environment:

  1. Clone the repository: git clone https://github.com/GarlicRot/AutoBucket.git
  2. Navigate to the project directory: cd AutoBucket
  3. Install dependencies: ./gradlew build
  4. Start making your changes!

Make sure to update any documentation relevant to your changes.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Keep messages short and descriptive.
  • Reference issues or pull requests when appropriate.

Java Style Guide

  • Follow standard Java conventions.
  • Use meaningful variable and method names.
  • Keep code DRY (Don't Repeat Yourself).
  • Ensure your code passes all tests before submitting.

License

By contributing, you agree that your contributions will be licensed under the same license as the project. See the LICENSE file for more details.