Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

94 lines (63 loc) · 3.72 KB
Raw

Contributing to SnapTalk 🎉

First off, thank you for considering contributing to SnapTalk! 🚀 Your contributions help us build a better platform where users can share their daily moments through snaps. Whether it’s a bug fix, feature enhancement, or new documentation, we’re excited to have you on board.

How to Contribute 📘

  1. Fork the Repository 🍴
  • Navigate to the SnapTalk GitHub repository.
  • Click on the Fork button in the upper-right corner of the page to create a copy of the repo on your GitHub account.

  1. Clone Your Forked Repository ⬇️

    Once you’ve forked the repository, clone it to your local machine using the following command:

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

    Replace with your GitHub username.

  2. Create a Branch 🌿

    Before making any changes, create a new branch to work on. Use a descriptive name for your branch to reflect the feature or fix you’re working on:

    git checkout -b feature/your-feature-name

    Or for a bug fix:

    git checkout -b fix/your-bug-fix

  3. Make Changes 🔧

    Now you’re ready to make changes! Whether you’re fixing a bug, adding a new feature, or updating the documentation, make sure your changes align with the following:

    • Write Clean Code: Keep your code concise, and ensure it follows the established coding standards.
    • Testing: Write tests if applicable and ensure that all existing tests pass.
    • Documentation: Update the documentation (README, tutorials, etc.) when changes require it.

  4. Test Your Changes ✅

    Before submitting a pull request, please test your changes locally to make sure the code works!

  5. Commit Your Changes 💾

    When committing your changes, please use clear and descriptive commit messages:

    git commit -m "Add feature X to enhance Y"

    Ensure each commit is small and addresses a single change for clarity.

  6. Push to Your Forked Repository 🚀

    After committing your changes, push them to your fork:

    git push origin feature/your-feature-name

  7. Submit a Pull Request (PR) 🔄

    Navigate to your fork on GitHub and click the New Pull Request button. Select your branch and compare it against the main branch of the main repository.

    In your pull request, please provide:

    • Description: Explain what changes you made, why you made them, and how they improve SnapTalk.
    • Issue Reference: If your PR addresses an existing issue, please link it in the PR description.
    • Screenshots (if applicable): Add screenshots or GIFs if your changes affect the user interface.

  8. PR Review & Feedback 🔍

    Once your PR is submitted, it will be reviewed by a team member. You may receive feedback or requests for changes. Don’t be discouraged — these reviews ensure code quality and consistency in the project.

Code Style Guidelines 💻

  • Follow the existing code style used in the project.
  • Use ESLint for JavaScript linting.
  • Consistent formatting helps keep the code readable.

Reporting Bugs 🐛

If you find a bug, you can help us by submitting an issue on GitHub Issues. Before opening an issue, please:

1. Search existing issues to ensure it’s not already reported.
2. If it’s a new bug, include detailed information, such as:
     - A clear title and description.
     - Steps to reproduce the bug.
     - Expected and actual behavior.
     - Any relevant screenshots or logs.

Requesting New Features 🌟

We welcome feature requests! If you have an idea for a new feature, you can open an issue labeled as a Feature Request. Please include:

  • A description of the feature and why it would be beneficial.
  • Any potential implementation ideas or examples.