Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update GitHub templates and added documentation files.
- Loading branch information
1 parent
9221b7e
commit 944b2a8
Showing
7 changed files
with
161 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Code of Conduct | ||
|
||
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# How to contribute | ||
|
||
There are lots of ways to contribute to the Uno CodeGen Tasks and we appreciate the help from the community. You can provide feedback, report bugs, give suggestions, contribute code, and participate in the platform discussions. | ||
|
||
## Code of conduct | ||
|
||
To better foster an open, innovative and inclusive community please refer to our [Code of Conduct](CODE_OF_CONDUCT.md) when contributing. | ||
|
||
### Report a bug | ||
|
||
If you think you've found a bug, please log a new issue in the [Uno CodeGen GitHub issue tracker](https://github.com/nventive/Uno.CodeGen/issues). When filing issues, please use our [bug filing template](.github/ISSUE_TEMPLATE.md). | ||
The best way to get your bug fixed is to be as detailed as you can be about the problem. | ||
Providing a minimal project with steps to reproduce the problem is ideal. | ||
Here are questions you can answer before you file a bug to make sure you're not missing any important information. | ||
|
||
1. Did you read the [documentation](https://github.com/nventive/Uno.CodeGen/tree/master/doc)? | ||
2. Did you include the snippet of broken code in the issue? | ||
3. What are the *EXACT* steps to reproduce this problem? | ||
4. What specific version or build are you using? | ||
5. What operating system are you using? | ||
|
||
GitHub supports [markdown](https://help.github.com/articles/github-flavored-markdown/), so when filing bugs make sure you check the formatting before clicking submit. | ||
|
||
### Make a suggestion | ||
|
||
If you have an idea for a new feature or enhancement let us know by filing an [issue](https://github.com/nventive/Uno.CodeGen/issues). To help us understand and prioritize your idea please provide as much detail about your scenario and why the feature or enhancement would be useful. | ||
|
||
### Ask questions | ||
|
||
If you have a question be sure to first checkout our [documentation](https://github.com/nventive/Uno.CodeGen/tree/master/doc). But if you are still stuck, you'll have a better chance of getting help on [StackOverflow](https://stackoverflow.com/questions/tagged/uno-platform) and we'll do our best to answer it. Questions asked there should be tagged with `uno-platform`. | ||
|
||
For a more direct conversation, [our gitter is also a good place to visit](https://gitter.im/uno-platform/Lobby). | ||
|
||
## Contributing code and content | ||
|
||
The Uno Platform is an open source project and we welcome code and content contributions from the community. | ||
|
||
**Identifying the scale** | ||
|
||
If you would like to contribute to one of our repositories, first identify the scale of what you would like to contribute. If it is small (grammar/spelling or a bug fix) feel free to start working on a fix. | ||
|
||
If you are submitting a feature or substantial code contribution, please discuss it with the team. You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. Note that all code submissions will be rigorously reviewed and tested by the Uno Platform team, and only those that meet an extremely high bar for both quality and design/roadmap appropriateness will be merged into the source. | ||
|
||
**Obtaining the source code** | ||
|
||
If you are an outside contributer, please fork the Uno CodeGen repository you would like to contribute to your account. See the GitHub documentation for [forking a repo](https://help.github.com/articles/fork-a-repo/) if you have any questions about this. | ||
|
||
**Submitting a pull request** | ||
|
||
If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests. Make sure the respository can build and all tests pass, as well as follow the current coding guidelines. | ||
|
||
Pull requests should all be done to the **master** branch. | ||
|
||
**Commit/Pull Request Format** | ||
|
||
``` | ||
Summary of the changes (Less than 80 chars) | ||
- Detail 1 | ||
- Detail 2 | ||
Addresses #bugnumber (in this specific format) | ||
``` | ||
|
||
**Tests** | ||
|
||
- Tests need to be provided for every bug/feature that is completed. | ||
- Tests only need to be present for issues that need to be verified by QA (e.g. not tasks) | ||
- If there is a scenario that is far too hard to test there does not need to be a test for it. | ||
- "Too hard" is determined by the team as a whole. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
title: | ||
author: GitHub_UserName | ||
description: describe your feature implementation | ||
keywords: uno platform, your feature | ||
dev_langs: | ||
- csharp | ||
--- | ||
|
||
<!-- To know about all the available Markdown syntax, Check out https://docs.microsoft.com/contribute/contribute/how-to-write-use-markdown --> | ||
<!-- Ensure you remove all comments before submission, to ensure that there are no formatting issues when displaying this page. --> | ||
<!-- It is recommended to check how the Documentation will look in the sample app, before Merging a PR --> | ||
|
||
# Title | ||
<!-- Describe your control --> | ||
The [Feature name] ... | ||
|
||
<!-- Use below format to display note | ||
> [!NOTE] | ||
Some note | ||
> [!IMPORTANT] | ||
Some important note | ||
> [!WARNING] | ||
Some warning note | ||
--> | ||
|
||
## Syntax | ||
|
||
```csharp | ||
|
||
``` | ||
|
||
```xaml | ||
|
||
``` | ||
|
||
## Sample Output | ||
|
||
<!-- Image/Text can show the output, if relevant --> | ||
|
||
## Sample Code | ||
|
||
<!-- Sample code for the control, if relevant --> | ||
|
||
## Requirements | ||
|
||
| Device family | Universal, MinVersion or higher | | ||
| -- | -- | | ||
| iOS | | | ||
| Android | | | ||
| WebAssembly | | | ||
|
||
## Limitations | ||
|
||
<!-- Current known limitations for the behavior of the control, if any --> | ||
|
||
## API Source Code | ||
|
||
- [control/helper name source code](source-code-link) | ||
|
||
## Related Topics | ||
|
||
<!-- Optional --> | ||
|
||
- [Topic 1](link) | ||
- [Topic 2](link) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Release notes | ||
|
||
## Next version | ||
|
||
### Features | ||
|
||
### Breaking changes | ||
|
||
### Bug fixes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters