Skip to content

Latest commit

 

History

History
57 lines (29 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

57 lines (29 loc) · 2.28 KB
Raw

Welcome to the HoverZoom Contributor's Guide! 🎉

First off, we're thrilled that you're interested in contributing to HoverZoom! 🌟 We're constantly looking for talented individuals like you to help us make HoverZoom even better. 😄

Getting Started 🚀

Before you start contributing, please take a moment to review our code of conduct: Code of Conduct.

How to Contribute 🤝

It's super easy to start contributing to HoverZoom. Just follow these simple steps:

  1. Fork this Repository 🍴

    Fork this repository to your own GitHub account. This creates a copy of HoverZoom under your account, which you can freely experiment with.

  2. Clone your Fork 💻

    Clone your forked repository to your local machine. Use git clone followed by your repository URL.

  3. Create a New Branch 🌿

    Create a new branch for your work. Make sure the branch name describes what you're working on.

  4. Work on Your Contribution 🛠️

    Make your awesome contributions to HoverZoom on your branch. Write code, fix bugs, add features, or improve documentation. Don't forget to add tests if applicable!

  5. Commit Your Changes ✅

    Commit your changes with clear and concise commit messages. Be descriptive and concise, so everyone knows what you did.

  6. Push Your Changes 🚀

    Push your changes to your forked repository on GitHub.

  7. Create a Pull Request 🚧

    Create a Pull Request (PR) to the main HoverZoom repository. We'll review your PR and provide feedback if needed.

  8. Get Your PR Merged! 🎉

    Once your PR is approved and any conflicts are resolved, it will be merged into the main repository. 🙌

  9. Celebrate! 🎉

    Congratulations! You've just made HoverZoom better. 🚁

Code Style and Guidelines 💅

We want to keep HoverZoom's code clean and consistent. Please follow our coding style and guidelines. We use PEP 8 for Python code and Airbnb JavaScript Style Guide for JavaScript.

Contributors 💪

We appreciate every contribution, big or small! Your name will be added to our list of amazing contributors in the README file.

Thank you for being a part of HoverZoom! We can't wait to see what amazing things we can build together. Happy coding! 🚁💻🌟