Skip to content

Files

Latest commit

 

History

History
65 lines (53 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

65 lines (53 loc) · 2.49 KB

Contributing to mongoq

Thank you for your interest in contributing to mongoq! Whether it's a bug fix, feature request, or a code improvement, we appreciate your effort to make this project better.

How You Can Contribute

🐛 Report Issues or Request Features

Found a bug or have a great idea for a feature?

  1. Head over to the Issues tab.
  2. Open a new issue with a clear and concise description of the problem or suggestion.
    • For feature requests, describe the use case and how it adds value to the library.
    • For bug reports, include steps to reproduce, expected behavior, and observed behavior.
  3. Label your issue appropriately to help us prioritize.

💡 Submit a Pull Request (PR)

If you want to fix a bug, implement a new feature, or improve the documentation:

  1. Fork the Repository

    • Visit mongoq repository.
    • Click the "Fork" button to create a copy in your GitHub account.
    • Clone your fork locally: 
      # Using SSH (recommended)
git clone git@github.com:<your-username>/mongoq.git
# Or using HTTPS
git clone https://github.com/<your-username>/mongoq.git
cd mongoq

  2. Create a Branch
    Always work in a new branch for your changes:

    git checkout -b my-new-feature

  3. Implement Changes

    • Write clear and concise code.
    • Add or update unit tests for your changes.
    • Update documentation if applicable.

  4. Rebase Your Changes
    Sync your branch with the latest main branch:

    git pull --rebase origin main

  5. Push and Submit Your PR
    Push your branch to your fork and submit a pull request to the main repository:

    git push origin my-new-feature
    • Go to your forked repository on GitHub and click "New Pull Request".
    • Ensure your PR has a clear title and detailed description.

📋 Guidelines for a Great Contribution

  • Follow the code style used in the repository.
  • Write descriptive commit messages.
  • Ensure all tests pass before submitting.
  • Be responsive to review feedback.

❤️ We Value Your Contributions

Whether you’re fixing a typo or proposing a major feature, your contributions make a difference. Don’t hesitate to start a discussion by opening an issue or joining the ongoing conversations.

Thank you for helping to improve mongoq! 🚀