Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.41 KB
Raw

Contributing to MCW

Thank you for considering contributing to MCW! This guide will help you get started and understand how you can make meaningful contributions to the project.

Getting Started

To get started with development, follow these steps:

  • Fork the repository on GitHub and clone your fork locally.
  • Create a new branch for your contribution: git checkout -b your-feature-name
  • Make your changes and commit them with a clear commit message.

Making Changes

  • Ensure your code adheres to the project's coding conventions and style guide.
  • Write clear, concise commit messages.
  • Keep your changes focused. If you're addressing multiple issues, create separate branches for each.
  • Update documentation to reflect your changes if applicable.

Ways to Contribute

Not all contributions come in the form of code. Here are some ways you can contribute:

  • Feature Requests: Propose new features or enhancements by creating an issue.
  • Bug Reports: Report bugs or issues you encounter.
  • Documentation: Improve existing documentation or write new documentation.
  • Code Contributions: Contribute code to fix bugs, add features, or improve performance.

Reporting Issues

  • Search for existing issues: Before creating a new issue, please check if the issue already exists.
  • Create a detailed issue: If the issue is new, create a detailed issue. Include steps to reproduce, expected behavior, and screenshots if applicable.