Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 2.99 KB
Raw

Contributing Guidelines for AutoModpack

Welcome to the AutoModpack project! We appreciate your interest in contributing to this effort to enhance the Minecraft modding experience. This document outlines the guidelines for contributing to the project. Whether you're a developer, a designer, or just someone passionate about gaming, there are various ways you can get involved.

Ways to Contribute

1. Code Contributions

If you're a developer, you can contribute to the AutoModpack project by writing code that enhances its features, fixes bugs, or optimizes performance. Here's how:

  1. Discuss the changes you want to make. By e.g. creating an issue.
  2. Fork the repository and create a new branch for your feature or bug fix.
  3. Make your code changes.
  4. Build code with ./gradlew chiseledBuild command.
  5. Test your changes thoroughly to prevent regressions.
  6. Submit a pull request, describing your changes and providing relevant context.

2. Documentation

Clear and comprehensive documentation is essential. You can contribute by improving existing documentation or creating new guides:

  1. Fork the repository and create a branch for your documentation changes.
  2. Make your changes to the documentation, keeping it concise and easy to understand.
  3. Ensure your changes are well-structured and contribute to a better user experience.
  4. Submit a pull request, explaining the purpose of your documentation changes.

3. Bug Reports and Feature Requests

If you encounter a bug while using AutoModpack or have an idea for a new feature, you can contribute by submitting issues:

  1. Go to the repository's "Issues" tab.
  2. Check if a similar issue or feature request already exists.
  3. If not, create a new issue, providing a clear description and steps to reproduce (for bugs).
  4. Engage in discussions related to the issue, providing additional information if needed.

4. Localization

If you would like to translate automodpack to other languages, go ahead!

  1. Fork the repository and create a new branch for your localization.
  2. Find /src/main/resources/assets/automodpack/lang/ directory.
  3. Here you can check if file with your language already exists by using minecraft's in-game locale codes, which you can find there.
  4. If file with your language doesn't exist just create it.
  5. Copy default values from e.g. en_us.json and translate it.
  6. Submit a pull request.

5. Spread the Word

Even if you're not a developer, you can still contribute by spreading the word about AutoModpack :)

Code of Conduct

We expect all contributors to adhere to a code of conduct that promotes a positive and inclusive environment. Respect each other's ideas, communicate effectively, and work together to achieve the project's goals.

Attribution

AutoModpack would not be possible without the collective efforts of numerous talented individuals. While you contribute to the project, remember that the content you download through the mod is credited to various creators.

Thank you.