diff --git a/IMPROVEMENTS_SUMMARY.md b/IMPROVEMENTS_SUMMARY.md index 80f0e0ff..dd7a0edc 100644 --- a/IMPROVEMENTS_SUMMARY.md +++ b/IMPROVEMENTS_SUMMARY.md @@ -3,17 +3,21 @@ ## Issues Fixed ### 1. Critical Spelling Errors + - **README.md**: Fixed "Reciepts" → "Receipts", "Scaner" → "Scanner", "extention" → "extension" - **Calculator-CLI.md**: Fixed "divison" → "division" ### 2. Tier Classification Inconsistency + - **Calendar App**: Moved from `Projects/1-Beginner/` to `Projects/3-Advanced/` to match its tier designation - **README.md**: Updated Calendar app listing to reference correct path ### 3. File Organization + - **Image-Scaner.md**: Renamed to `Image-Scanner.md` to fix spelling and updated README reference ### 4. Markdown Standards Compliance + - **README.md**: Fixed list marker spacing (3 spaces → 1 space), removed trailing punctuation from headings - **Calculator-CLI.md**: Fixed trailing spaces and list marker consistency - **Multiple project files**: Fixed list marker spacing in sample files: @@ -23,24 +27,28 @@ - `Calculator-App.md` ### 5. Quality Improvements + - **STYLE_GUIDE.md**: Created comprehensive style and quality guide for future contributions - **Markdown linting**: Addressed MD030, MD026, MD009, MD004, MD047 issues across multiple files ## Impact ### Repository Quality + - Fixed **7+ spelling errors** across documentation - Resolved **1 major tier inconsistency** affecting project organization - Improved **markdown compliance** in 5+ files - Enhanced **overall professionalism** and consistency ### Developer Experience + - Easier navigation with corrected file names and paths - Consistent formatting improves readability - Clear style guide helps future contributors - Professional appearance increases repository credibility ### Maintainability + - Established quality standards for future contributions - Reduced confusion from inconsistent formatting - Created systematic approach to quality control @@ -65,4 +73,4 @@ - **1 file relocated** for tier accuracy - **1 new documentation** file created -This comprehensive fix addresses both immediate issues and establishes standards for long-term repository quality. \ No newline at end of file +This comprehensive fix addresses both immediate issues and establishes standards for long-term repository quality. diff --git a/Projects/1-Beginner/Calculator-App.md b/Projects/1-Beginner/Calculator-App.md index 04eb130c..123651e2 100644 --- a/Projects/1-Beginner/Calculator-App.md +++ b/Projects/1-Beginner/Calculator-App.md @@ -5,7 +5,7 @@ Calculators are not only one of the most useful tools available, but they are also a great way to understand UI and event processing in an application. In this problem you will create a calculator that supports basic arithmetic -calculations on integers. +calculations on integers. The styling is up to you so use your imagination and get creative! You might also find it worth your time to experiment with the calculator app on your @@ -18,33 +18,33 @@ mobile device to better understand basic functionality and edge cases. ## User Stories - [ ] User can see a display showing the current number entered or the -result of the last operation. + result of the last operation. - [ ] User can see an entry pad containing buttons for the digits 0-9, -operations - '+', '-', '/', and '=', a 'C' button (for clear), and an 'AC' -button (for clear all). + operations - '+', '-', '/', and '=', a 'C' button (for clear), and an 'AC' + button (for clear all). - [ ] User can enter numbers as sequences up to 8 digits long by clicking on -digits in the entry pad. Entry of any digits more than 8 will be ignored. + digits in the entry pad. Entry of any digits more than 8 will be ignored. - [ ] User can click on an operation button to display the result of that -operation on: + operation on: - the result of the preceding operation and the last number entered OR - the last two numbers entered OR - the last number entered - [ ] User can click the 'C' button to clear the last number or the last -operation. If the users last entry was an operation the display will be -updated to the value that preceded it. + operation. If the users last entry was an operation the display will be + updated to the value that preceded it. - [ ] User can click the 'AC' button to clear all internal work areas and -to set the display to 0. + to set the display to 0. - [ ] User can see 'ERR' displayed if any operation would exceed the -8 digit maximum. + 8 digit maximum. ## Bonus features - [ ] User can click a '+/-' button to change the sign of the number that is -currently displayed. + currently displayed. - [ ] User can see a decimal point ('.') button on the entry pad to that -allows floating point numbers up to 3 places to be entered and operations to -be carried out to the maximum number of decimal places entered for any one -number. + allows floating point numbers up to 3 places to be entered and operations to + be carried out to the maximum number of decimal places entered for any one + number. ## Useful links and resources diff --git a/Projects/2-Intermediate/Calculator-CLI.md b/Projects/2-Intermediate/Calculator-CLI.md index 845e0354..4cc1f0f6 100644 --- a/Projects/2-Intermediate/Calculator-CLI.md +++ b/Projects/2-Intermediate/Calculator-CLI.md @@ -10,7 +10,7 @@ Create a basic calculator with addition feature. - [ ] User can add floating numbers using the `-f` flag. - [ ] User can add only even/odd numbers using `even`/`odd` sub-command. - [ ] User can use `--help` or `-h` flag to get all the available commands and flags. - + > Note: The stories 1 and 2 are basically for static typed language, where passed arguments must be of same type. ## Bonus Features