Contributing to Smart Student Assignment Tracker
Thank you for your interest in contributing to this project.
Prerequisites
Before contributing, ensure you have: Python 3.12+ Git VS Code (recommended)
Installation
Clone the repository: git clone cd Smart-Student-Assignment-Tracker
Install dependencies: pip install -r requirements.txt
Run the application: py -3.12 -m uvicorn main:app --reload
Run tests: py -3.12 -m pytest
Coding Standards
Follow PEP8 conventions. Write meaningful commit messages. Add tests for new features. Ensure all tests pass before submitting a Pull Request.
Contribution Process
- Fork the repository.
- Create a feature branch.
- Implement your changes.
- Run all tests.
- Submit a Pull Request.
Pull Request Requirements
Clear title and description. Related issue referenced. Tests passing. Documentation updated if required.