Skip to content

Contributing

Jump to bottom
NightDawnEX edited this page Mar 28, 2024 · 5 revisions

We're excited to have you join our community of developers and contributors. Whether you're looking to fix bugs, add new features, or improve documentation, your contributions are valuable to us. This page outlines how you can contribute to the MAGI project, including our guidelines and processes for submitting contributions.

Getting Started

Before you begin contributing, please take a moment to familiarize yourself with our project:

  • Read the documentation: Understand how MAGI works and its core principles. Our Wiki and README files are great places to start.
  • Set up your environment: Ensure you have the necessary development environment set up. Refer to our Setup Guide for instructions.
  • Explore open issues: Check out the current issues to see if there's something you'd like to work on. Feel free to ask questions or discuss your ideas before starting work.

How to Contribute

Reporting Bugs

If you've found a bug, we'd appreciate it if you reported it to us:

  1. Check if the bug is already reported: Browse our issues to see if it's already been reported.
  2. Create a new issue: If the bug is new, open a new issue. Provide a clear title and a detailed description. Include steps to reproduce the bug, the expected outcome, and the actual result. Attach screenshots or code snippets if applicable.

Suggesting Enhancements

We welcome suggestions for improvements or new features:

  1. Discuss your idea: Start by discussing your idea in an existing issue or create a new one. This allows the community to provide feedback and suggestions.
  2. Draft your proposal: Outline your proposed changes, including any technical details and implications for existing functionality.
  3. Submit a feature request: If the feedback is positive, submit your feature request as an issue, detailing the proposal and any additional context.

Submitting Changes

Ready to submit your code? Here's how:

  1. Fork the repository: Create your own fork of the MAGI repository.
  2. Create a branch: Make your changes in a new git branch based on the project's main branch.
  3. Commit your changes: Make sure your commits are small and focused. Use clear and descriptive commit messages.
  4. Test your changes: Ensure your code adheres to the project's coding standards and passes all tests.
  5. Submit a pull request (PR): Push your branch to your fork and open a pull request to the main MAGI repository. Provide a clear PR title and description of your changes. Link any related issues.

Code Review Process

Once your PR is submitted, the project maintainers will review your changes. During the review process, you may receive feedback or requests for modifications. Keep the following in mind:

  • Be patient: Reviews can take time. Please be patient while your PR is being reviewed.
  • Address feedback: If you receive feedback, respond to comments and make any requested changes. Use the PR discussion to clarify any questions.
  • PR acceptance: Once your PR is accepted, a maintainer will merge it into the project.

Community and Conduct

MAGI is committed to fostering an inclusive and welcoming community. We expect everyone to adhere to our Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank You

Thank you for considering contributing to MAGI. Your efforts help make MAGI better for everyone. If you have any questions or need help, don't hesitate to ask in our community channels.

Clone this wiki locally