Skip to content

Latest commit

 

History

History
94 lines (60 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

94 lines (60 loc) · 4.12 KB
Raw

Contributing to League Of Languages

Welcome to the "League Of Languages" project! We appreciate your interest in contributing to our open-source project. By contributing, you can help us improve the script and enhance its features.

Before you begin, please take a moment to read and understand our contribution guidelines.

Table of Contents

Code of Conduct

We expect all contributors to follow our Code of Conduct in all interactions and contributions to this project. It outlines our commitment to creating a welcoming and inclusive environment for everyone.

How to Contribute

Contributing to "League Of Languages" is easy! Here's how you can get started:

  1. Fork the Repository: Click the "Fork" button on the top right corner of the repository's page. This creates a copy of the repository in your own GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine using Git:

    git clone https://github.com/YourUsername/LeagueOfLanguages.git

  3. Make Changes: Make your desired changes or improvements to the codebase.

  4. Test Your Changes: Ensure that your changes work as expected and do not introduce new issues.

  5. Commit Changes: Commit your changes with clear and descriptive commit messages. Please follow the Git Commit Message Guidelines.

  6. Push Changes: Push your commits to your forked repository on GitHub:

    git push origin your-branch-name

  7. Create a Pull Request (PR): Visit the original repository and click on the "New Pull Request" button. Provide a clear description of your changes and submit the PR.

Our team will review your contributions and provide feedback. Thank you for helping us improve "League Of Languages"!

Git Commit Message Guidelines

When committing changes to the "League Of Languages" repository, please follow these guidelines for clear and informative commit messages:

  • Use the present tense ("Add feature" instead of "Added feature").
  • Use imperative mood ("Fix bug" instead of "Fixes bug").
  • Keep the subject line concise (50 characters or less).
  • Separate the subject from the body with a blank line.
  • Limit the subject line to a single line, if possible.
  • Capitalize the subject line and begin with a verb (e.g., "Update documentation").
  • Use the body of the commit message to provide more details, if necessary.

Here's an example of a well-formatted commit message:

Add new feature to customize game resolution

This commit adds a new feature that allows users to customize their
game resolution in the script settings. It provides flexibility for
players who prefer different resolutions for a better gaming experience.

Following these guidelines ensures that commit messages are clear, easy to understand, and help maintain a well-documented project history.

Submitting Changes

When submitting changes, please follow these guidelines:

  • Make sure your code adheres to the existing coding style and conventions.
  • Include relevant tests and ensure they pass.
  • Provide clear and concise documentation for any new features or changes.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. When reporting issues, be sure to include:

  • A clear and descriptive title.
  • Detailed steps to reproduce the issue.
  • Any relevant error messages or screenshots.

Community and Communication

Feel free to reach out to us if you have questions, need assistance, or want to discuss potential contributions. We look forward to collaborating with you to improve "League Of Languages"!

Thank you for your interest and contributions!