diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83e27da..dc2977e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,124 @@ -PS C:\Users\doza5\GSSoC-contribution1-\InfantCareCompass> git branch ->> -* add-files - master -PS C:\Users\doza5\GSSoC-contribution1-\InfantCareCompass> git checkout -b add-contributing ->> -Switched to a new branch 'add-contributing' -PS C:\Users\doza5\GSSoC-contribution1-\InfantCareCompass> git branch -* add-contributing - add-files - master -PS C:\Users\doza5\GSSoC-contribution1-\InfantCareCompass> git status -On branch add-contributing -Changes not staged for commit: - (use "git add/rm ..." to update what will be committed) - (use "git restore ..." to discard changes in working directory) - deleted: CONTRIBUTING.md - -no changes added to commit (use "git add" and/or "git commit -a") \ No newline at end of file +# Contributing to InfantCareCompass +Hi there! πŸ‘‹ +Thank you for your interest in contributing to InfantCareCompass β€” a platform designed to support the health, safety, and care of infants. Whether you're here to fix bugs, improve features, or help with documentation, you're in the right place! + +We welcome contributions from everyone β€” beginners, students, open-source lovers, and professionals alike πŸ’™ + +# πŸ“œ Code of Conduct +Please read our Code of Conduct before participating. We aim to create a positive and respectful environment for all contributors. + +#🧩 Ways to Contribute +You can help us grow in many ways: + +πŸ› Reporting or fixing bugs + +πŸ“± Improving the UI/UX + +✨ Suggesting or adding new features + +πŸ§ͺ Writing or improving tests + +πŸ“ Enhancing documentation + +🌐 Adding support for multiple languages + +πŸŽ“ Helping new contributors + +# πŸ› οΈ Getting Started +1. Fork the Repository +Click the Fork button at the top right of the repo: +πŸ”— InfantCareCompass Repository + +2. Clone Your Fork +bash +Copy +Edit +git clone https://github.com/YOUR-USERNAME/InfantCareCompass.git +cd InfantCareCompass +3. Install Dependencies +If the project uses Node.js/React or similar, install dependencies: + +bash +Copy +Edit +npm install +If it uses another stack, check the project-specific instructions in the README.md. + +4. Create a New Branch +bash +Copy +Edit +git checkout -b your-branch-name +Use meaningful names like fix-broken-nav or add-signup-feature. + +# ✍️ Making Changes +Write clean, readable code + +Leave helpful comments if necessary + +Keep commits atomic and meaningful + +Test your code locally + +Avoid committing node_modules, .env, or other generated files + +πŸ“€ Submitting a Pull Request +Stage and commit your changes: + +bash +Copy +Edit +git add . +git commit -m "fix: corrected footer links" # use descriptive message +Push your branch to your forked repo: + +bash +Copy +Edit +git push origin your-branch-name +Go to the original repo and open a Pull Request against the master branch + +Fill out the pull request description clearly: + +What did you fix/add? + +Any related issue (e.g., Closes #12) + +Screenshots (if UI-related) + +🧠 Good Practices +Follow Conventional Commits + +Keep PRs focused and easy to review + +Avoid breaking existing features + +Run linters/formatters if used in the project + +Use draft PRs if your work is in progress + +# πŸ“š Useful Resources +GitHub Docs – Fork a repo + +GitHub Docs – Creating a pull request + +Git Tutorial for Beginners (YouTube) + +GSSoC Contribution Guide + +Good First Issue in This Repo + +πŸ™‹β€β™€οΈ Need Help? +If you're stuck or unsure: + +Open an issue labeled question + +Ask in your pull request comments + +Tag a maintainer for guidance + +We’re here to support you πŸ’› + +Thank you for contributing to InfantCareCompass! +Let’s make infant care more accessible and effective β€” together 🍼✨ +