All notable changes to this project will be documented in this file. Include your changes above the most recent log, the last changelog is a template to follow.
PR Title: [Hacktoberfest] [Code Formatting] Changed all eggs to omelettes.
Summary: Changed all eggs to omelettes in the codebase to make it more readable and consistent.
- Feature foo
- eggs to omelettes
- Bug baz
PR Title: [Formatting]: Pre-commit formatter X Ruff. Closes #22
Summary: Integrated pre-commit formatter with Ruff to ensure consistent code formatting.
- Pre-commit formatter with Ruff
- Code formatting to comply with Ruff rules
- N/A
PR Title: [API Docs]: Teacher yml files for /apidocs fixed. Closes #19
Summary: Fixed the Teacher YAML files for the API documentation.
- N/A
- Teacher YAML files for API documentation
- Teacher YAML files for API documentation
PR Title: [Environment]: Adjust app to use dynamic host in swagger, and updated README to reflect
Summary: Adjusted the application to use a dynamic host in Swagger and updated the README to reflect these changes.
- N/A
- Application configuration to use dynamic host in Swagger
- Updated README
- N/A
PR Title: [Header]: Update Header badge links, add pre-commit badge
Summary: Updated the header badge links and added a pre-commit badge.
- Pre-commit badge
- Header badge links
- N/A
PR Title: [Docs]: Update README and requirements for pre-commit hook
Summary: Updated the README and requirements to include information about the pre-commit hook.
- Information about pre-commit hook in README
- Requirements file
- N/A
PR Title: [DOCS]: Contribution, Licensing and Conduct
Summary: Updated the documentation for contribution, licensing, and code of conduct.
- Contribution guidelines
- Licensing information
- Code of conduct
- N/A
- N/A
PR Title: [Docs]: Changelog, updates to contributing and Readme
Summary: Updated the changelog, contributing guidelines, and README.
- N/A
- Changelog
- Contributing guidelines
- README
- N/A
PR Title: [API Docs]: Teacher yml files for /apidocs fixed
Summary: Fixed the Teacher YAML files for the API documentation.
- N/A
- Teacher YAML files for API documentation
- Teacher YAML files for API documentation
PR Title: [Ignore]: env vars
Summary: Ignored environment variables in the repository.
- N/A
- N/A
- Ignored environment variables
PR Title: [Revise]: Fix urls and Requirements for eventual deployment
Summary: Fixed URLs and updated requirements for eventual deployment.
- N/A
- URLs
- Requirements
- N/A