diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 851ea9eb..e0217867 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,13 +17,11 @@ all community interactions must abide by the [Code of Conduct](CODE_OF_CONDUCT.m ## Finding issues you can help with Looking for something to work on? -[Issues marked *up for grabs*](https://microsoft.com/#TODO_MIGRATE_THIS_LINK_AFTER_GITHUB_MIGRATION) +[Issues marked *good first issue*](https://github.com/Microsoft/calculator/labels/good%20first%20issue) are a good place to start. -Another way you can help is by reproducing issues others have reported. -[Issues marked *more info needed*](https://microsoft.com/#TODO_MIGRATE_THIS_LINK_AFTER_GITHUB_MIGRATION) -don't have all the information needed to take action. You can try to reproduce the issue on your -machine and add more details so we can take action on the report. +You can also check [the *help wanted* tag](https://github.com/Microsoft/calculator/labels/help%20wanted) +to find other issues to help with. ## Contributions we accept We welcome your contributions to the Calculator project, especially to fix bugs and to make @@ -79,7 +77,7 @@ participate in the review, but at least one member of the Calculator team will u the request. Often, multiple iterations will be needed to responding to feedback from reviewers. Try looking at -[past pull requests](https://microsoft.com/#TODO_MIGRATE_THIS_LINK_AFTER_GITHUB_MIGRATION) to see +[past pull requests](https://github.com/Microsoft/calculator/pulls?q=is%3Apr+is%3Aclosed) to see what the experience might be like. ## Contributor License Agreement diff --git a/README.md b/README.md index 08848d00..97099ba8 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ The app provides standard, scientific, and programmer calculator functionality, Calculator ships regularly with new features and bug fixes. You can get the latest version of Calculator in the [Windows Store.](https://www.microsoft.com/store/apps/9WZDNCRFHVN5) - + [![Build Status](https://microsoft.visualstudio.com/Apps/_apis/build/status/Utility%20Apps/Calculator-Daily)](https://microsoft.visualstudio.com/Apps/_build?definitionId=3539) - ![Calculator Screenshot](\docs\Images\CalculatorScreenshot.png) + ![Calculator Screenshot](docs/Images/CalculatorScreenshot.png) ## Features - Standard Calculator functionality which offers basic operations and evaluates commands immediately as they are entered. @@ -25,47 +25,19 @@ Prerequisites: - Install the optional "C++ Universal Windows Platform tools" component - Install the latest Windows 10 SDK - ![Visual Studio Installation Screenshot](\docs\Images\VSInstallationScreenshot.png) + ![Visual Studio Installation Screenshot](docs/Images/VSInstallationScreenshot.png) - Install the [XamlStyler](https://marketplace.visualstudio.com/items?itemName=TeamXavalon.XAMLStyler) Visual Studio extension - - Get the code: ``` - git clone https://microsoft.visualstudio.com/DefaultCollection/Apps/_git/calculator.app + git clone https://github.com/Microsoft/calculator.git ``` -- Open [src\Calculator.sln](\src\Calculator.sln) in Visual Studio to build and run the Calculator app. -- For a general description of the Calculator project architecture see [ApplicationArchitecture.md](docs\ApplicationArchitecture.md). - -## Running Tests -To run tests in Visual Studio, install [TDP](https://osgwiki.com/wiki/TDP) and use the TAEF explorer pane. - -Calculator has two primary sets of tests: -- [CalculatorUnitTests.vcxproj](\src\CalculatorUnitTests\CalculatorUnitTests.vcxproj) - Unit Tests -- [UIAutomationTests.csproj](\src\UIAutomationTests\UIAutomationTests.csproj) - UI Automation using [MitaLite](http://osgwiki.com/mitalite) - -## Exploring the repo -- [Build](\build) - Scripts which run during the build -- [Docs](\Docs) - Documentation for developers -- [Loc](\Loc) - Localization settings and files -- [PDP](\PDP) - Information about the app for the Store's Product Description Page -- [SpkgDefs](\SpkgDefs) - Definitions for building [test packages](https://osgwiki.com/wiki/Test_Package) -- [Src](\src) - Main folder for source code -- [Tools](\tools) - Scripts and tools to aid in development -- [TRexDefs](\TRexDefs) - Definitions for running tests using [TReX](https://osgwiki.com/wiki/TReX) +- Open [src\Calculator.sln](/src/Calculator.sln) in Visual Studio to build and run the Calculator app. +- For a general description of the Calculator project architecture see [ApplicationArchitecture.md](docs/ApplicationArchitecture.md). ## Contributing -Want to contribute? The team encourages community feedback and contributions. Please follow our [contributing guidelines](\CONTRIBUTING.md). +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 you want to submit an issue to this repository, please read the -[issue reporting guidelines](\IssueTracking.md). - - - - -## Contact -Questions? Reach out to the PAX Essential Experiences App email alias: \ No newline at end of file +We also welcome [issues submitted on GitHub](https://github.com/Microsoft/calculator/issues). \ No newline at end of file diff --git a/docs/ApplicationArchitecture.md b/docs/ApplicationArchitecture.md index 3e1c4f8e..fa77b041 100644 --- a/docs/ApplicationArchitecture.md +++ b/docs/ApplicationArchitecture.md @@ -162,20 +162,20 @@ The RatPack (short for Rational Pack) is the core of the Calculator model and co [XAML Overview]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/xaml-overview [MVVM]: https://docs.microsoft.com/en-us/windows/uwp/data-binding/data-binding-and-mvvm -[Calculator folder]: ..\src\Calculator -[App.xaml]: ..\src\Calculator\App.xaml -[App.xaml.cpp]: ..\src\Calculator\App.xaml.cpp +[Calculator folder]: ../src/Calculator +[App.xaml]: ../src/Calculator/App.xaml +[App.xaml.cpp]: ../src/Calculator/App.xaml.cpp [StaticResource]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/staticresource-markup-extension [ThemeResource]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/themeresource-markup-extension [Page]: https://docs.microsoft.com/en-us/uwp/api/Windows.UI.Xaml.Controls.Page [UserControl]: https://docs.microsoft.com/en-us/uwp/api/Windows.UI.Xaml.Controls.UserControl -[MainPage.xaml]: ..\src\Calculator\Views\MainPage.xaml -[Calculator.xaml]: ..\src\Calculator\Views\Calculator.xaml -[CalculatorStandardOperators.xaml]: ..\src\Calculator\Views\CalculatorStandardOperators.xaml -[CalculatorScientificOperators.xaml]: ..\src\Calculator\Views\CalculatorScientificOperators.xaml -[CalculatorProgrammerOperators.xaml]: ..\src\Calculator\Views\CalculatorProgrammerOperators.xaml -[DateCalculator.xaml]: ..\src\Calculator\Views\DateCalculator.xaml -[UnitConverter.xaml]: ..\src\Calculator\Views\UnitConverter.xaml +[MainPage.xaml]: ../src/Calculator/Views/MainPage.xaml +[Calculator.xaml]: ../src/Calculator/Views/Calculator.xaml +[CalculatorStandardOperators.xaml]: ../src/Calculator/Views/CalculatorStandardOperators.xaml +[CalculatorScientificOperators.xaml]: ../src/Calculator/Views/CalculatorScientificOperators.xaml +[CalculatorProgrammerOperators.xaml]: ../src/Calculator/Views/CalculatorProgrammerOperators.xaml +[DateCalculator.xaml]: ../src/Calculator/Views/DateCalculator.xaml +[UnitConverter.xaml]: ../src/Calculator/Views/UnitConverter.xaml [VisualState]: https://docs.microsoft.com/en-us/windows/uwp/design/layout/layouts-with-xaml#adaptive-layouts-with-visual-states-and-state-triggers [Style]: https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/xaml-styles @@ -186,17 +186,17 @@ The RatPack (short for Rational Pack) is the core of the Calculator model and co [Binding]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/binding-markup-extension [BindingComparison]: https://docs.microsoft.com/en-us/windows/uwp/data-binding/data-binding-in-depth#xbind-and-binding-feature-comparison -[CalcViewModel folder]: ..\src\CalcViewModel -[ApplicationViewModel.h]: ..\src\CalcViewModel\ApplicationViewModel.h -[StandardCalculatorViewModel.h]: ..\src\CalcViewModel\StandardCalculatorViewModel.h -[DateCalculatorViewModel.h]: ..\src\CalcViewModel\DateCalculatorViewModel.h -[UnitConverterViewModel.h]: ..\src\CalcViewModel\UnitConverterViewModel.h +[CalcViewModel folder]: ../src/CalcViewModel +[ApplicationViewModel.h]: ../src/CalcViewModel/ApplicationViewModel.h +[StandardCalculatorViewModel.h]: ../src/CalcViewModel/StandardCalculatorViewModel.h +[DateCalculatorViewModel.h]: ../src/CalcViewModel/DateCalculatorViewModel.h +[UnitConverterViewModel.h]: ../src/CalcViewModel/UnitConverterViewModel.h [INotifyPropertyChanged]: https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.data.inotifypropertychanged [PropertyChanged]: https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.data.inotifypropertychanged.propertychanged -[Utils.h]: ..\src\CalcViewModel\Common\Utils.h +[Utils.h]: ../src/CalcViewModel/Common/Utils.h -[CalcManager folder]: ..\src\CalcManager -[CalculatorManager.h]: ..\src\CalcManager\CalculatorManager.h -[CalcEngine.h]: ..\src\CalcManager\Header Files\CalcEngine.h -[ratpak.h]: ..\src\CalcManager\Ratpack\ratpak.h +[CalcManager folder]: ../src/CalcManager +[CalculatorManager.h]: ../src/CalcManager/CalculatorManager.h +[CalcEngine.h]: ../src/CalcManager/Header Files/CalcEngine.h +[ratpak.h]: ../src/CalcManager/Ratpack/ratpak.h \ No newline at end of file