Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

85 lines (63 loc) · 3.99 KB

Contributing to Attack On Titan: Utopia

Thank you for your interest in contributing to Attack On Titan: Utopia! Whether you're here to report a bug, suggest a new feature, improve the documentation, or contribute code, your efforts are greatly appreciated. This guide will help you get started.

Table of Contents

Code of Conduct

Please note that this project is governed by a Code of Conduct, which you can review here. By participating, you are expected to uphold this code. Please report any unacceptable behavior to [email protected].

How to Contribute

Reporting Issues

If you find a bug or have an idea for an improvement, please let us know by creating an issue:

  1. Navigate to the Issues section.
  2. Search to see if the issue has already been reported. If so, feel free to add any additional information or comments.
  3. If not, create a new issue with a clear and descriptive title.
  4. Provide as much detail as possible: steps to reproduce, expected results, and screenshots if applicable.

Suggesting Features

We welcome suggestions that can enhance the gameplay or improve the project:

  1. Open a new issue in the Issues section.
  2. Describe the feature you'd like to see, why it's important, and how it could benefit the project.

Contributing Code

If you're interested in contributing code, that's fantastic! Here’s how to get started:

  1. Fork the repository to your GitHub account.
  2. Create a new branch from main for your changes (e.g., feature/my-new-feature).
  3. Make your changes in the new branch.
  4. Ensure your code adheres to the Style Guidelines.
  5. Write tests for your changes, if applicable.
  6. Commit your changes with clear, concise commit messages.
  7. Push your branch to your forked repository.
  8. Submit a pull request (PR) to the main branch in the original repository.

Development Setup

Prerequisites

  • Java Development Kit (JDK): Ensure you have the latest version of JDK installed.

Setting Up the Project

  1. Clone the repository: 
    git clone https://github.com/yehiarasheed/Attack-On-Titan-Utopia.git
cd Attack-On-Titan-Utopia
  2. Open the project in your favorite IDE (e.g., IntelliJ IDEA, Eclipse).

Pull Request Process

  1. Before submitting a PR, ensure your code follows the project's Style Guidelines.
  2. Make sure all tests pass and consider adding new tests for your changes.
  3. Once your pull request is submitted, it will be reviewed by the maintainers. We might request changes, so please be responsive.
  4. After approval, your PR will be merged into the main branch. Thank you for your contribution!

Style Guidelines

To maintain consistency across the codebase:

  • Follow the standard Java coding conventions.
  • Use meaningful variable and method names.
  • Document your code with clear comments where necessary.
  • Keep methods small and focused—preferably, a method should do one thing only.
  • Test your code thoroughly before submitting.

Attribution

Feel free to give credit where it’s due:

  • If you’re using third-party resources (libraries, code snippets), ensure they’re properly attributed.
  • All contributors will be acknowledged in the project documentation.

We’re excited to see your contributions and help make Attack On Titan: Utopia even better! If you have any questions or need assistance, don't hesitate to reach out to the project owners at [email protected]. Happy coding!