Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 1.96 KB
Raw

Contributing to MonkeyslegionDB

Thank you for your interest in contributing to MonkeyslegionDB! We appreciate your effort, and to ensure that your contributions are integrated smoothly, please follow these guidelines.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

Getting Started

  • Fork the repository on GitHub.
  • Clone your fork to your local machine.
  • Run composer install to install the development dependencies.

Reporting Issues

Before submitting a new issue, please:

  • Check if the issue has already been reported.
  • Follow the issue template provided.

Submitting Changes

  1. Create a new branch for each feature, fix, or documentation improvement.
  2. Write your code, following the coding standards mentioned below.
  3. Write or update tests for the new or changed functionality.
  4. Run the test suite to ensure that all tests pass.
  5. Commit your changes, writing a good commit message.
  6. Push your changes to your fork on GitHub.
  7. Create a new pull request, following the pull request template provided.

Coding Standards

  • Follow the PSR-12 coding standard.
  • Use meaningful variable names and add comments to your code.
  • Keep methods small and focused.

Running Tests

To run tests, execute the following command:

composer test

Documentation

If you are contributing new features or changes that require updates to the documentation, please include those updates in your pull request.

Review Process

  1. A core contributor will review your pull request and provide feedback.
  2. Once the pull request is approved, it will be merged into the main branch.

Recognition

All contributors will be recognized in the CHANGELOG.md and via GitHub's contributor graph.

License

By contributing to MonkeyslegionDB, you agree that your contributions will be licensed under the MIT license.

Thank you for contributing to MonkeyslegionDB!