Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 2.79 KB
Raw

How to Contribute to UnixMC

Thank you for your interest in contributing to UnixMC! Whether you're looking to report bugs, suggest features, or contribute code, this guide will help you get started.

Table of Contents

Understanding the Project

Before contributing, take some time to learn about UnixMC:

  • Read the README.md: Get to know the purpose, features, and structure of the project.
  • Review the Code of Conduct: Understand the standards and expectations for behavior within our community.

Initial Engagement

  1. Join Our Community: The first step to contributing is joining our Discord community. It's where we discuss the project, plan features, and offer support.
  2. Express Your Interest: Let us know what you're interested in working on. Whether it's coding, documentation, or community support, your contributions are valuable.

Contribution Opportunities

  • Bug Reports: Help improve UnixMC by reporting bugs. Use our Bug Report Template to provide detailed information.
  • Feature Suggestions: Have an idea? Submit a feature request using our Feature Request Template.
  • Code Contributions: Before contributing code, please reach out to us on Discord to discuss your ideas. Due to the project's nature, direct code contributions may require signing a Non-Disclosure Agreement (NDA).

Making Your Contribution

After identifying how you'd like to contribute, follow these steps to make it happen:

  • For bug reports and feature suggestions, submit an issue on GitHub, following the appropriate template.
  • For code contributions:
    1. Discuss your idea with the project maintainers on Discord.
    2. Fork the repository (if applicable).
    3. Create a new branch for your contributions.
    4. Commit your changes with descriptive messages.
    5. Open a pull request detailing your changes and how they improve the project.

Community Conduct

All contributors are expected to adhere to our Code of Conduct. We're committed to providing a welcoming and supportive environment for all members of our community.

Questions and Support

If you have any questions or need assistance, don't hesitate to reach out on Discord or open an issue on GitHub for community support.

We're excited to have you join the UnixMC community and look forward to your contributions!