Update readme, contributing.
This commit is contained in:
Jerome Laban
Родитель
8a9b2d1944
Коммит
d3aeb3ce1b
|
|
@ -3,13 +3,12 @@ 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 Calculator is not working properly, please [file a report](https://github.com/nventive/calculator/issues).
|
||||
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
|
||||
[Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130) and see if others have
|
||||
[GitHub issues](https://github.com/nventive/calculator/issues) and see if others have
|
||||
submitted similar feedback. You can upvote existing feedback or submit a new suggestion.
|
||||
|
||||
We always look at upvoted items in Feedback Hub when we decide what to work on next. We read the
|
||||
|
|
@ -18,10 +17,10 @@ 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 [``good first issue``](https://github.com/Microsoft/calculator/labels/good%20first%20issue)
|
||||
Issues marked [``good first issue``](https://github.com/nventive/calculator/labels/good%20first%20issue)
|
||||
are a good place to start.
|
||||
|
||||
You can also check the [``help wanted``](https://github.com/Microsoft/calculator/labels/help%20wanted) tag to find
|
||||
You can also check the [``help wanted``](https://github.com/nventive/calculator/labels/help%20wanted) tag to find
|
||||
other issues to help with. If you're interested in working on a fix, leave a comment to let everyone know and to help
|
||||
avoid duplicated effort from others.
|
||||
|
||||
|
|
@ -58,10 +57,7 @@ To learn how to build the code and run tests, follow the instructions in the [RE
|
|||
|
||||
### Style guidelines
|
||||
The code in this project uses several different coding styles, depending on the age and history of
|
||||
the code. Please attempt to match the style of surrounding code as much as possible. In new
|
||||
components, prefer the patterns described in the
|
||||
[C++ core guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines)
|
||||
and the [modern C++/WinRT language projections](https://docs.microsoft.com/en-us/windows/uwp/cpp-and-winrt-apis/).
|
||||
the code. Please attempt to match the style of surrounding code as much as possible.
|
||||
|
||||
### Testing
|
||||
Your change should include tests to verify new functionality wherever possible. Code should be
|
||||
|
|
@ -89,16 +85,3 @@ the request.
|
|||
Often, multiple iterations will be needed to responding 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.
|
||||
|
||||
## Contributor License Agreement
|
||||
Before we can review and accept a pull request from you, you'll need to sign a Contributor License
|
||||
Agreement (CLA). The CLA ensures that the community is free to use your contributions. More
|
||||
information about the agreement is available on the [Microsoft web site](https://cla.opensource.microsoft.com/).
|
||||
Signing the CLA is an automated process, and you only need to do it once for Microsoft projects on
|
||||
GitHub.
|
||||
|
||||
You don't need to sign a CLA until you're ready to create a pull request. When your pull request is
|
||||
created, it is classified by a bot. If the change is trivial (i.e. you just fixed a typo) then the
|
||||
bot will label the PR `cla-not-required`. Otherwise, it's classified as `cla-required`. In that
|
||||
case, the system will also tell you how you can sign the CLA. Once you have signed a CLA, the
|
||||
current and all future pull requests will be labeled as `cla-signed`.
|
||||
|
|
|
|||
43
README.md
43
README.md
|
|
@ -1,10 +1,12 @@
|
|||
# Calculator
|
||||
The Windows Calculator app is a modern Windows app written in C++ that ships pre-installed with Windows.
|
||||
# Uno Calculator
|
||||
|
||||
The Uno Calculator is a port of the [Windows Calculator](https://github.com/microsoft/calculator) to C# and to the [Uno Platform](https://platform.uno) for iOS, Android and WebAssembly.
|
||||
|
||||
The app provides standard, scientific, and programmer calculator functionality, as well as a set of converters between various units of measurement and currencies.
|
||||
|
||||
Calculator ships regularly with new features and bug fixes. You can get the latest version of Calculator in the [Microsoft Store](https://www.microsoft.com/store/apps/9WZDNCRFHVN5).
|
||||
The Uno Calculator will regularly follow with the Windows Calculator updates. You can get it from the [App Store](https://bit.ly/calc-ios), [Play Store](https://play.google.com/store/apps/details?id=uno.platform.calculator), [in your browser](https://calculator.platform.uno), and of course the original calculator on the [Microsoft Store](https://www.microsoft.com/store/apps/9WZDNCRFHVN5).
|
||||
|
||||
[](https://dev.azure.com/ms/calculator/_build/latest?definitionId=57&branchName=master)
|
||||
[](https://uno-platform.visualstudio.com/Uno%20Platform/_build?definitionId=55&_a=summary)
|
||||
|
||||
|
||||
|
||||
|
|
@ -23,46 +25,29 @@ Calculator ships regularly with new features and bug fixes. You can get the late
|
|||
## Getting started
|
||||
Prerequisites:
|
||||
- Your computer must be running Windows 10, version 1803 or newer.
|
||||
- Install the latest version of [Visual Studio](https://developer.microsoft.com/en-us/windows/downloads) (the free community edition is sufficient).
|
||||
- Install the latest version of [Visual Studio](https://developer.microsoft.com/en-us/windows/downloads).
|
||||
- Install the "Universal Windows Platform Development" workload.
|
||||
- Install the optional "C++ Universal Windows Platform tools" component.
|
||||
- Install the Xamarin Development component
|
||||
- Install the optional "Mobile C++ development tools" component.
|
||||
- Install the latest Windows 10 SDK.
|
||||
|
||||
|
||||
- Install the [XAML Styler](https://marketplace.visualstudio.com/items?itemName=TeamXavalon.XAMLStyler) Visual Studio extension.
|
||||
> When using Visual Studio 2019, the `.vsconfig` feature will automatically prompt to install missing components.
|
||||
|
||||
- Get the code:
|
||||
```
|
||||
git clone https://github.com/Microsoft/calculator.git
|
||||
git clone https://github.com/nventive/calculator
|
||||
```
|
||||
|
||||
- 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).
|
||||
|
||||
If 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
|
||||
For information regarding Windows Calculator plans and release schedule, please see the [Windows Calculator Roadmap](docs/Roadmap.md).
|
||||
If Calculator is not working properly, please [file an issue](https://github.com/nventive/calculator/issues).
|
||||
|
||||
## Data / Telemetry
|
||||
This project collects usage data and sends it to Microsoft to help improve our products and services.
|
||||
Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkId=521839) to learn more.
|
||||
Telemetry is disabled in development builds by default, and can be enabled with the `SEND_TELEMETRY`
|
||||
build flag.
|
||||
This project collects usage data and sends it to App Center to help improve the quality of the calculator.
|
||||
|
||||
## Reporting Security Issues
|
||||
Security issues and bugs should be reported privately, via email, to the
|
||||
Microsoft Security Response Center (MSRC) at <[secure@microsoft.com](mailto:secure@microsoft.com)>.
|
||||
You should receive a response within 24 hours. If for some reason you do not, please follow up via
|
||||
email to ensure we received your original message. Further information, including the
|
||||
[MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the
|
||||
[Security TechCenter](https://technet.microsoft.com/en-us/security/default).
|
||||
|
||||
## License
|
||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
|
||||
Licensed under the [MIT License](./LICENSE).
|
||||
Security issues and bugs should be reported through the [GitHub security tab](https://github.com/nventive/calculator/security).
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче