diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e0217867..a319d7ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,11 +3,11 @@ The Calculator team encourages community feedback and contributions. Thank you f making Calculator better! There are several ways you can get involved. ## Reporting issues and suggesting new features -If Calculator is not working properly, please file a report in the [Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130&newFeedback=True). +If the Calculator is not working properly, please file a report in the [Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130&newFeedback=True). Feedback Hub reports automatically include diagnostic data, such as the version of Calculator you're using. -We are happy to hear your ideas for the future of Calculator. Check the +We are happy to hear your ideas for the future of the Calculator. Check the [Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130) and see if others have submitted similar feedback. You can upvote existing feedback or submit a new suggestion. @@ -45,12 +45,12 @@ components, prefer the patterns described in the [C++ core guidelines](http://is and the [modern C++/WinRT language projections](https://docs.microsoft.com/en-us/windows/uwp/cpp-and-winrt-apis/). ### Testing -Your change should include tests to verify new functionality wherever possible. Code should be +Your change should include tests to verify new functionality wherever possible. The code should be structured so that it can be unit tested independently of the UI. [Manual test cases](docs/ManualTests.md) should be used where automated testing is not feasible. ### Git workflow -Calculator uses the [GitHub flow](https://guides.github.com/introduction/flow/) where most +The Calculator uses the [GitHub flow](https://guides.github.com/introduction/flow/) where most development happens directly on the `master` branch. The `master` branch should always be in a healthy state which is ready for release. @@ -76,7 +76,7 @@ assign the request to an appropriate reviewer within two days. Any member of the participate in the review, but at least one member of the Calculator team will ultimately approve the request. -Often, multiple iterations will be needed to responding to feedback from reviewers. Try looking at +Often, multiple iterations will be needed to respond to feedback from reviewers. Try looking at [past pull requests](https://github.com/Microsoft/calculator/pulls?q=is%3Apr+is%3Aclosed) to see what the experience might be like. diff --git a/README.md b/README.md index ba76c48b..b46089ce 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Calculator ships regularly with new features and bug fixes. You can get the late ## Features - Standard Calculator functionality which offers basic operations and evaluates commands immediately as they are entered. -- Scientific Calculator functionality which offers expanded operations and evaluates commands using order of operations. +- Scientific Calculator functionality which offers expanded operations and evaluates commands using the order of operations. - Programmer Calculator functionality which offers common mathematical operations for developers including conversion between common bases. - Calculation history and memory capabilities. - Conversion between many units of measurement. @@ -38,7 +38,7 @@ Prerequisites: ## Contributing Want to contribute? The team encourages community feedback and contributions. Please follow our [contributing guidelines](CONTRIBUTING.md). -If Calculator is not working properly, please file a report in the [Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130). +If the Calculator is not working properly, please file a report in the [Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130). We also welcome [issues submitted on GitHub](https://github.com/Microsoft/calculator/issues). ## Roadmap diff --git a/docs/ApplicationArchitecture.md b/docs/ApplicationArchitecture.md index 0d7c2ff3..46b2df1a 100644 --- a/docs/ApplicationArchitecture.md +++ b/docs/ApplicationArchitecture.md @@ -1,7 +1,7 @@ # Application Architecture Windows Calculator is a [C++/CX][C++/CX] application, built for the Universal Windows Platform ([UWP][What is UWP?]). -Calculator uses the [XAML][XAML Overview] UI framework, and the project follows the Model-View-ViewModel ([MVVM][MVVM]) +The calculator uses the [XAML][XAML Overview] UI framework, and the project follows the Model-View-ViewModel ([MVVM][MVVM]) design pattern. This document discusses each of the layers and how they are related to the three Visual Studio projects that build into the final Calculator application. @@ -56,7 +56,7 @@ Once the window is resized to have enough space, the panel becomes docked along #### Scientific mode, inverse function button presence -In the Scientific mode, for small window sizes there is not enough room to show all the function buttons. The mode +In the Scientific mode, for small window sizes, there is not enough room to show all the function buttons. The mode hides some of the buttons and provides a Shift (↑) button to toggle the visibility of the collapsed rows. When the window size is large enough, the buttons are re-arranged to display all function buttons at the same time. @@ -64,14 +64,14 @@ window size is large enough, the buttons are re-arranged to display all function #### Unit Converter aspect ratio adjustment -In the Unit Converter mode, the converter inputs and the numberpad will re-arrange depending on if the window is in +In the Unit Converter mode, the converter inputs and the number pad will re-arrange depending on if the window is in a Portrait or Landscape aspect ratio. ### Data-Binding -Calculator uses [data binding][Data Binding] to dynamically update the properties of UI elements. If this concept +The calculator uses [data binding][Data Binding] to dynamically update the properties of UI elements. If this concept is new for you, it's also worth reading about [data binding in depth][Data binding in depth]. The [x:Bind][x:Bind] markup extension is a newer replacement for the older [Binding][Binding] style. You may see both diff --git a/docs/ManualTests.md b/docs/ManualTests.md index deb8111a..6feebd0c 100644 --- a/docs/ManualTests.md +++ b/docs/ManualTests.md @@ -124,13 +124,13 @@ Steps: m. “( )" Parenthesis -**All Calulators Test: Verify memory functions** +**All Calculators Test: Verify memory functions** Steps: 1. Launch the "Calculator" app. 2. Navigate to "Standard" Calculator. 3. Perform a calculation and press the MS button. -4. If small scale, Select the (M) with the drop down arrow -*Expected: Calculation from previous step is present.* +4. If small scale, Select the (M) with the drop-down arrow +*Expected: Calculation from the previous step is present.* 5. Click the (M+) Add to Memory. *Expected: Previous calculation is added to itself.* 6. Click the (M-) Subtract from Memory. @@ -210,7 +210,7 @@ Steps: *Expected: All buttons are present and the up arrow is grayed out.* 6. For Scientific Mode: At a Smaller Scale *Expected: All buttons are present and the up arrow is able to be toggled.* -7. For Programmer Mode: At a Any Scale +7. For Programmer Mode: At an Any Scale *Expected: All buttons are present and the up arrow is able to be toggled.* 8. For Converter Mode: While Scaling *Expected: The number pad and input areas move around each other gracefully.* @@ -237,11 +237,11 @@ Verify the following: For Programmer Mode Verify the following: 6. "Bit Toggling Keypad": -*Expected: In app keypad changes to represent Bits (1s and 0s).* +*Expected: In-app keypad changes to represent Bits (1s and 0s).* 7. "QWORD / DWORD / WORD / BYTE": *Expected: Toggles as expected.* 8. "Hex" Hexadecimal: -*Expected: A B C D E F become active and user can use them. A maximum of 16 characters can be entered.* +*Expected: A B C D E F become active and the user can use them. A maximum of 16 characters can be entered.* 9. "Dec" Decimal: *Expected: A B C D E F are inactive. A maximum of 19 characters can be entered.* 10. "Oct" Octal: diff --git a/docs/NewFeatureProcess.md b/docs/NewFeatureProcess.md index 6aa2e22a..a05aa88f 100644 --- a/docs/NewFeatureProcess.md +++ b/docs/NewFeatureProcess.md @@ -27,7 +27,7 @@ It will typically include these sections: customer need or pain point we need to remedy? Is there a business goal or metric we are trying to improve? Do we have a hypothesis we want to prove or disprove? * **Evidence or User Insights**: Why should we do this? Potential sources of data: Feedback Hub, - other GitHub issues, other anecdotes from listening to customers in person or online, request + other GitHub issues, other anecdotes from listening to customers in person or online, a request from another team, telemetry data, user research, market or competitive research * **Proposal**: How will the solution/feature help us solve the problem? How will it meet the target audience’s needs? If there are business goals or metrics, how does this improve them? @@ -72,7 +72,7 @@ addressed: - [ ] Does the design include provisions for [all users](https://docs.microsoft.com/en-us/windows/uwp/design/accessibility/designing-inclusive-software) and [all cultures](https://docs.microsoft.com/en-us/windows/uwp/design/globalizing/guidelines-and-checklist-for-globalizing-your-app)? - [ ] Is it technically feasible to build this feature? Take a look at the "before committing" - checklist below and identify any issues which are likely to be blockers. + the checklist below and identify any issues which are likely to be blockers. ## Step 3: Production A feature can be implemented by the original proposer, a Microsoft team member, or by other