diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f377603 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contributing to StudyBuddy + +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. + +--- + +## πŸ” 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 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 +``` + +### 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/ +```