Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

78 lines (55 loc) · 3.16 KB
Raw

Contributing to Mivro

Thank you for your interest in contributing to the Mivro project! We appreciate your help in making this project better. Whether you're fixing bugs, suggesting features, or improving documentation, here’s how you can get involved.

How to Contribute

Reporting Issues

If you encounter any issues with a Mivro project, please follow these steps:

  1. Check for Existing Issues: Before creating a new issue, review the Issues page in the relevant repository to see if your problem has already been reported.

  2. Create a New Issue:

    • Navigate to the Issues page for the relevant repository.
    • Click "New Issue".
    • Provide a clear and descriptive title for the issue.
    • Include detailed information about the issue, such as steps to reproduce, expected and actual results. Attach screenshots if applicable to help illustrate the issue.

Suggesting Enhancements

Have an idea to improve Mivro? We’d love to hear it! Here’s how to suggest an enhancement:

  1. Check for Existing Suggestions: Look through the Issues page in the relevant repository to ensure your idea hasn’t already been suggested.

  2. Submit a New Enhancement Request:

    • Go to the Issues page for the relevant repository.
    • Click "New Issue".
    • Choose the "Enhancement" template.
    • Provide a detailed description of your idea and its potential benefits.

Contributing Code

Ready to contribute code? Please follow these guidelines:

  1. Fork the Repository: Click the "Fork" button at the top right of the relevant repository to create your own copy.

  2. Clone Your Fork:

    git clone https://github.com/<your-username>/<repository>.git

  3. Create a New Branch:

    git checkout -b <your-branch-name>

  4. Make Your Changes: Work on your changes and commit them with a clear message.

    git add .
git commit -m "Describe your changes"

  5. Push Your Changes:

    git push origin <your-branch-name>

  6. Create a Pull Request:

    • Go to the Pull Requests page in the relevant repository.
    • Click "New Pull Request".
    • Select your branch and provide a description of your changes.
    • Naming Your Pull Request:
      • For new features or improvements: [Food Icon] [Version Number] Description of the feature or improvement
        • Example: 🥕 [v1.0.0] Integrated new search engine capabilities
      • For fixes: FIXES #<issue-number> 🛠️ [Version Number] Description of the fix
        • Example: FIXES #1 🛠️ [v1.0.0] Corrected barcode scanning issue
    • Submit your pull request for review.

Code of Conduct

Please adhere to the Code of Conduct to ensure a welcoming and respectful environment for everyone involved in the project.

Getting Help

If you need assistance or have questions about contributing, feel free to:

  • Join the Discussion: Engage with the community on our Discussions page.
  • Join Us on Discord: Connect with us directly on our Discord server.