Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (51 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 2.42 KB
Raw

Contributing

Welcome to Clave-App – Contributing Guide

Hey there! 👋

First off, thanks so much for your interest in helping out with Clave-App. Every bit of feedback, code, and creativity helps make this project better for everyone. Whether you're a seasoned developer or just starting out, you’re more than welcome here!

How to Get Started

  1. Fork First:
    Hit the “Fork” button at the top right of our repository page to make your own copy.

  2. Clone Your Fork:

    git clone https://github.com/1dev-hridoy/Clave-App.git

  3. Install the Project:
    Check out the README for details on how to set everything up locally. If you hit any roadblocks, don’t hesitate to open an issue or ask for help.

  4. Create a Feature Branch:
    Work on your fix or feature in its own branch:

    git checkout -b feature/amazing-contribution

Making Your Contribution

  • Keep It Focused:
    Tackle one problem per pull request. This makes things easier to review!

  • Write Some Tests:
    If possible, add or update tests to make sure everything works as expected.

  • Comment & Document:
    If you think something in your code is tricky, leave a comment or note. Updates to documentation (README.md etc.) are always appreciated!

  • Commit Thoughtfully:
    Write descriptive commit messages. Briefly say what’s changed and why.

Submitting a Pull Request

  1. Push to Your Fork:

    git push origin feature/amazing-contribution

  2. Open a PR:
    Go to the original Clave-App repo and open a pull request from your branch.

  3. Describe Your Work:
    Tell us:

    • What does your change do?
    • Why did you make it?
    • Reference any related issues (“Fixes #12” or “Closes #34”).
    • Any caveats, screenshots, or details – don’t be shy!

How to Get in Touch

  • Bugs or ideas?
    Please open an issue and tell us about it!

  • Questions?
    Create an issue, start a discussion, or reach out wherever is convenient.

Code Style & Conduct

  • Please follow the style you see in the project.
  • Most of all, be respectful. We're here to help and learn together.

Thanks again for helping make Clave-App awesome.
Happy coding!