Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 2.32 KB
Raw

Contributing to the ModPosh collection

Introduction

Thank you for your interest in contributing to the ModPosh collection! We value the contributions from the community and are glad that you're interested in helping improve this project. This document outlines the guidelines for contributing, which help maintain the project's quality and keep the process efficient and respectful.

How to Contribute

There are many ways to contribute to this project:

  • Reporting Bugs: If you find a bug, please open an issue in the repository using the bug report template.
  • Suggesting Enhancements: If you have ideas on improving the project, open an issue using the feature request template.
  • Code Contributions: You can contribute to the codebase through pull requests. Please read the section below on how to submit a pull request.

Pull Request Process

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Clone the Fork: Clone your fork to your local machine.
  3. Create a New Branch: For each new feature or fix, create a separate branch.
  4. Make Your Changes: Implement your changes or fixes in the branch, adhering to the coding standards and guidelines of the project.
  5. Test Your Changes: Ensure your changes don't break any existing functionality.
  6. Commit Your Changes: Commit your changes with a clear and descriptive message.
  7. Push to Your Fork: Push your changes to your fork on GitHub.
  8. Submit a Pull Request: Open a pull request from your fork to the main repository. Fill in the pull request template with all relevant information.
  9. Review and Merge: Your pull request will be reviewed by the maintainers and, if deemed appropriate, merged into the project.

Coding Standards and Guidelines

  • Follow the coding style and best practices as much as possible.
  • Include comments in your code where necessary.
  • Update the documentation to reflect your changes.

Community Guidelines

We expect all contributors to be respectful and constructive in their communication. Harassment, trolling, and abuse are strictly prohibited.

Feedback and Questions

If you have any questions or feedback about contributing, open an issue for discussion.

Thank you for your contributions, and we look forward to your participation in making the ModPosh collection better!