Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

90 lines (56 loc) · 3.21 KB

Contributing to Mixeway Flow

First off, thank you for considering contributing to Mixeway Flow! Contributions of all kinds are welcome, including bug reports, feature requests, code, documentation, and design.

How to Contribute

1. Reporting Bugs

If you find a bug, please report it by opening an issue. Please use the issue template provided and include as much detail as possible:

  • Describe the bug and the steps to reproduce it.
  • Include screenshots or logs if applicable.
  • Specify the environment in which the bug occurred (OS, browser, etc.).

2. Suggesting Enhancements

We welcome ideas for new features and improvements. To suggest an enhancement:

  • Check if the feature is already requested in the issues section.
  • If not, open a new issue and describe the enhancement in detail.
  • Explain why the feature would be useful and how it could be implemented.

3. Contributing Code

If you're ready to start contributing code, follow these steps:

Fork the Repository

Create a Branch

  • Create a branch for your work: 
    git checkout -b feature/your-feature-name
    Use a clear and descriptive name for your branch.

Make Changes

  • Write clear, concise, and well-documented code.
  • Ensure your code follows the project's style guide.
  • Add or update tests to cover your changes.

Commit Your Changes

  • Commit your changes with a meaningful commit message:
git commit -m "Add feature to do X"

Push Your Changes

  • Push your changes to your forked repository:

Submit a Pull Request

  • Go to the original repository and open a pull request.
  • Clearly describe your changes and the problem they solve.
  • Ensure all checks pass (CI, tests, etc.).

4. Code Review Process

All pull requests are subject to a code review:

  • A maintainer will review your PR and provide feedback.
  • Be ready to make changes based on feedback.
  • Once approved, your changes will be merged into the main branch.

5. Style Guide

Please ensure your code adheres to the following standards:

  • Formatting: Use Prettier or the project's existing configuration for consistent formatting.
  • Linting: Ensure your code passes all linting checks using ESLint (or similar tools based on the language).
  • Tests: Write unit and integration tests where appropriate. Use Jest (or the project's existing test framework).
  • Documentation: Update the documentation in the docs/ directory if your changes affect the public API or require further explanation.

6. Community and Communication

We welcome contributions from everyone. Please respect our Code of Conduct when interacting with others.

If you have any questions or need further guidance, feel free to reach out via Discord or open an issue.

Thank you for contributing to Mixeway Flow!