From 944b2a8f9d1796eb15ef0a108ae89318fcc5078c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Agn=C3=A8s=20Zitte?= Date: Wed, 31 Oct 2018 13:18:20 -0400 Subject: [PATCH] Update GitHub templates and added documentation files. --- .github/ISSUE_TEMPLATE.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 6 +-- CODE_OF_CONDUCT.md | 3 ++ CONTRIBUTING.md | 69 +++++++++++++++++++++++++++++++ doc/.feature-template.md | 68 ++++++++++++++++++++++++++++++ doc/ReleaseNotes/_ReleaseNotes.md | 9 ++++ readme.md | 8 ++++ 7 files changed, 161 insertions(+), 4 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 doc/.feature-template.md create mode 100644 doc/ReleaseNotes/_ReleaseNotes.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 674c517..9c55cf4 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -11,7 +11,7 @@ ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION. - + ## Current behavior diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 517e8ca..89937b4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -26,11 +26,11 @@ What kind of change does this PR introduce? Please check if your PR fulfills the following requirements: -- [ ] Tested code with current [supported SDKs](../README.md#supported) -- [ ] Docs have been added/updated which fit [documentation template](https://github.com/nventive/Uno/blob/master/doc/.feature-template.md). (for bug fixes / features) +- [ ] Tested code with current [supported SDKs](../README.md) +- [ ] Docs have been added/updated which fit [documentation template](https://github.com/nventive/Uno.CodeGen/tree/master/doc/.feature-template.md). (for bug fixes / features) - [ ] Tests for the changes have been added (for bug fixes / features) (if applicable) - [ ] Contains **NO** breaking changes -- [ ] Updated the [Release Notes](https://github.com/nventive/Uno/tree/master/doc/ReleaseNotes) +- [ ] Updated the [Release Notes](https://github.com/nventive/Uno.CodeGen/tree/master/doc/ReleaseNotes) - [ ] Associated with an issue (GitHub or internal) + + + +# Title + +The [Feature name] ... + + + +## Syntax + +```csharp + +``` + +```xaml + +``` + +## Sample Output + + + +## Sample Code + + + +## Requirements + +| Device family | Universal, MinVersion or higher | +| -- | -- | +| iOS | | +| Android | | +| WebAssembly | | + +## Limitations + + + +## API Source Code + +- [control/helper name source code](source-code-link) + +## Related Topics + + + +- [Topic 1](link) +- [Topic 2](link) diff --git a/doc/ReleaseNotes/_ReleaseNotes.md b/doc/ReleaseNotes/_ReleaseNotes.md new file mode 100644 index 0000000..cdd3d6e --- /dev/null +++ b/doc/ReleaseNotes/_ReleaseNotes.md @@ -0,0 +1,9 @@ +# Release notes + +## Next version + +### Features + +### Breaking changes + +### Bug fixes diff --git a/readme.md b/readme.md index b9b808e..a5c7f7e 100644 --- a/readme.md +++ b/readme.md @@ -66,3 +66,11 @@ Features: ### 1.22.0 (May 17th 2018) - Added support for System.Guid as a supported immutable type. + +# Have questions? Feature requests? Issues? + +Make sure to visit our [FAQ](doc/faq.md), [StackOverflow](https://stackoverflow.com/questions/tagged/uno-platform), [create an issue](https://github.com/nventive/Uno.CodeGen/issues) or [visit our gitter](https://gitter.im/uno-platform/Lobby). + +# Contributing + +Read our [contributing guide](CONTRIBUTING.md) to learn about our development process and how to propose bug fixes and improvements.