From c796733d504ddc48ce903e99d5bb29d2929a762f Mon Sep 17 00:00:00 2001 From: Arpit Singh Tomar Date: Sun, 1 Mar 2026 00:29:40 +0530 Subject: [PATCH 1/2] Add files via upload --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b17f978 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to StudyBuddy + +Thank you for taking the time to contribute to StudyBuddy! πŸŽ‰ +We welcome contributions from beginners and experienced developers alike. + +--- + +## πŸ“Œ How to Contribute + +1. Fork the repository from GitHub. +2. Clone your forked repository to your local machine. +3. Create a new branch for your changes. +4. Make your changes and test them. +5. Submit a Pull Request (PR). + +--- + +## πŸ› οΈ Project Setup (Local) + +### Prerequisites +- Python 3.8 or higher +- Git +- Basic knowledge of Django (optional but helpful) + +### Installation Steps + +```bash +git clone https://github.com//StudyBuddy.git +cd StudyBuddy +pip install -r requirements.txt \ No newline at end of file From e223016eae5a95e978e9f16087728d54ac0f3942 Mon Sep 17 00:00:00 2001 From: Arpit Singh Tomar Date: Sun, 1 Mar 2026 16:32:19 +0530 Subject: [PATCH 2/2] Improve CONTRIBUTING.md with detailed guidelines --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 43 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b17f978..f377603 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,30 +1,67 @@ # Contributing to StudyBuddy -Thank you for taking the time to contribute to StudyBuddy! πŸŽ‰ -We welcome contributions from beginners and experienced developers alike. +Thank you for your interest in contributing to **StudyBuddy**! πŸŽ‰ +We appreciate all kinds of contributions β€” whether it’s fixing bugs, improving documentation, enhancing UI, or adding new features. + +This guide will help you get started with contributing to the project. + +--- + +## πŸ“Œ Ways to Contribute + +You can contribute to StudyBuddy in many ways, including: +- Fixing bugs +- Improving documentation +- Enhancing UI/UX +- Adding new features +- Refactoring existing code + +Before starting, please check the **Issues** section to see if the problem or feature is already discussed. --- -## πŸ“Œ How to Contribute +## πŸ” Contribution Workflow 1. Fork the repository from GitHub. 2. Clone your forked repository to your local machine. 3. Create a new branch for your changes. -4. Make your changes and test them. -5. Submit a Pull Request (PR). +4. Make your changes and test them locally. +5. Commit your changes with a clear message. +6. Push your branch to GitHub. +7. Submit a Pull Request (PR). --- ## πŸ› οΈ Project Setup (Local) ### Prerequisites +Make sure you have the following installed: - Python 3.8 or higher +- pip - Git - Basic knowledge of Django (optional but helpful) +--- + ### Installation Steps ```bash git clone https://github.com//StudyBuddy.git cd StudyBuddy -pip install -r requirements.txt \ No newline at end of file +pip install -r requirements.txt +``` + +### Running the Project + +Apply migrations and start the development server: + +```bash +python manage.py migrate +python manage.py runserver +``` + +Open your browser and visit: + +```bash +http://127.0.0.1:8000/ +```