From 297801ff716b057e37c55b021a5c8beef2479315 Mon Sep 17 00:00:00 2001 From: Rashidaga18 Date: Sun, 24 Aug 2025 14:06:47 +0530 Subject: [PATCH 1/2] Added Contributing.md file --- Contributing.md | 111 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 111 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..ede7bff --- /dev/null +++ b/Contributing.md @@ -0,0 +1,111 @@ +# Contributing to Ayurleaf + +Thank you for showing interest in contributing to **Ayurleaf**! πŸš€ +We welcome contributions of all kinds β€” whether it's fixing bugs, adding new features, improving documentation, or helping with testing. + +Please take a moment to review this guide to make the contribution process smooth and effective. + +--- + +## πŸ› οΈ How to Contribute + +### 1. Fork the Repository +- Click on the **Fork** button at the top-right of this repository to create your own copy. + +### 2. Clone Your Fork +```bash +git clone https://github.com//Aurleaf.git +cd Aurleaf + +# 3. Set Up the Project + +Frontend +cd Frontend +npm install +npm run dev + +Backend +cd backend +npm install +npm start + + +Make sure you configure your environment variables in a .env file inside the backend folder: + +PORT=3000 +MONGODB_URI=your_mongodb_connection_url + +4. Create a New Branch + +Before making changes, create a branch: + +git checkout -b feature/your-feature-name + + # 5. Make Your Changes + +Add your feature, fix a bug, or improve documentation. + +Ensure your code follows the project’s coding standards. + +6. Commit Your Changes + +Write clear and descriptive commit messages: + +git add . +git commit -m "Add: implemented location-based search filter" + +7. Push Your Branch +git push origin feature/your-feature-name + +8. Create a Pull Request (PR) + +Go to the original repository on GitHub. + +Click on Pull Request β†’ New Pull Request. + +Select your branch and submit the PR with a clear description of the changes. + +## πŸ’‘ Contribution Guidelines + +Write clean, maintainable, and well-documented code. + +Use meaningful commit messages (e.g., "Fix: booking system bug" instead of "fixed stuff"). + +Test your code before submitting a PR. + +Keep PRs small and focused β€” one feature/fix per PR. + +Update relevant documentation if your changes affect usage. + +🌟 Areas You Can Contribute + +Frontend: UI improvements, responsiveness, new components. + +Backend: APIs, database integrations, authentication. + +AI Features: Enhancing chatbot, improving personalized health assistance. + +Documentation: Improving README, adding examples, or clarifying setup steps. + +Bug Fixes: Identifying and resolving issues. + +πŸ§‘β€πŸ€β€πŸ§‘ Code of Conduct + +Please be respectful and professional in all interactions. +We follow a Code of Conduct to maintain a welcoming and inclusive environment for everyone. + +πŸ™Œ Need Help? + +If you face any issues while contributing: + +Check the existing Issues +. + +Open a new issue if your problem is not listed. + +You can also start a discussion or reach out via the repository. + +πŸ’– A Big Thank You + +Every contribution β€” big or small β€” is valuable and appreciated. +By contributing to Ayurleaf, you’re helping build a platform that makes Ayurvedic healthcare more accessible to everyone. 🌿 \ No newline at end of file From d518be84a854600909846db3efb18681dccd27cb Mon Sep 17 00:00:00 2001 From: Rashi Daga <138892734+Rashidaga18@users.noreply.github.com> Date: Sun, 24 Aug 2025 15:29:49 +0530 Subject: [PATCH 2/2] Update Contributing.md --- Contributing.md | 55 ++++++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 26 deletions(-) diff --git a/Contributing.md b/Contributing.md index ede7bff..e78615d 100644 --- a/Contributing.md +++ b/Contributing.md @@ -1,7 +1,7 @@ # Contributing to Ayurleaf -Thank you for showing interest in contributing to **Ayurleaf**! πŸš€ -We welcome contributions of all kinds β€” whether it's fixing bugs, adding new features, improving documentation, or helping with testing. +Thank you for showing interest in contributing to **Ayurleaf**! +We welcome contributions of all kinds whether it's fixing bugs, adding new features, improving documentation, or helping with testing. Please take a moment to review this guide to make the contribution process smooth and effective. @@ -16,55 +16,58 @@ Please take a moment to review this guide to make the contribution process smoot ```bash git clone https://github.com//Aurleaf.git cd Aurleaf - -# 3. Set Up the Project +``` +### 3. Set Up the Project Frontend +```bash cd Frontend npm install npm run dev - +``` Backend +```bash cd backend npm install npm start - - +``` +```bash Make sure you configure your environment variables in a .env file inside the backend folder: PORT=3000 MONGODB_URI=your_mongodb_connection_url - -4. Create a New Branch +``` +### 4. Create a New Branch Before making changes, create a branch: - +```bash git checkout -b feature/your-feature-name - - # 5. Make Your Changes +``` + ### 5. Make Your Changes Add your feature, fix a bug, or improve documentation. Ensure your code follows the project’s coding standards. -6. Commit Your Changes +### 6. Commit Your Changes Write clear and descriptive commit messages: - +```bash git add . git commit -m "Add: implemented location-based search filter" - -7. Push Your Branch +``` +### 7. Push Your Branch +```bash git push origin feature/your-feature-name - -8. Create a Pull Request (PR) - +``` +### 8. Create a Pull Request (PR) +```bash Go to the original repository on GitHub. Click on Pull Request β†’ New Pull Request. Select your branch and submit the PR with a clear description of the changes. - +``` ## πŸ’‘ Contribution Guidelines Write clean, maintainable, and well-documented code. @@ -77,7 +80,7 @@ Keep PRs small and focused β€” one feature/fix per PR. Update relevant documentation if your changes affect usage. -🌟 Areas You Can Contribute +## 🌟 Areas You Can Contribute Frontend: UI improvements, responsiveness, new components. @@ -89,12 +92,12 @@ Documentation: Improving README, adding examples, or clarifying setup steps. Bug Fixes: Identifying and resolving issues. -πŸ§‘β€πŸ€β€πŸ§‘ Code of Conduct +## πŸ§‘β€πŸ€β€πŸ§‘ Code of Conduct Please be respectful and professional in all interactions. We follow a Code of Conduct to maintain a welcoming and inclusive environment for everyone. -πŸ™Œ Need Help? +## πŸ™Œ Need Help? If you face any issues while contributing: @@ -105,7 +108,7 @@ Open a new issue if your problem is not listed. You can also start a discussion or reach out via the repository. -πŸ’– A Big Thank You +## πŸ’– A Big Thank You -Every contribution β€” big or small β€” is valuable and appreciated. -By contributing to Ayurleaf, you’re helping build a platform that makes Ayurvedic healthcare more accessible to everyone. 🌿 \ No newline at end of file +Every contribution big or small is valuable and appreciated. +By contributing to Ayurleaf, you’re helping build a platform that makes Ayurvedic healthcare more accessible to everyone. 🌿