Родитель
9d3c8fef4f
Коммит
4d6768250d
|
@ -1,6 +1,6 @@
|
|||
# Contributing
|
||||
|
||||
The WindowsUIDevLabs repo is built on open source principles. We welcome and encourage community contributions to help improve the codebase, samples, and overall quality of this project. In order to contribute, please follow the guidelines below. Thank you for your interest in the Windows.UI.Composition Samples project!
|
||||
The Windows Composition Samples repo is built on open source principles. We welcome and encourage community contributions to help improve the codebase, samples, and overall quality of this project. In order to contribute, please follow the guidelines below. Thank you for your interest in the Windows.UI.Composition Samples project!
|
||||
|
||||
## Prerequisite - CLA
|
||||
|
||||
|
@ -47,11 +47,11 @@ Using Visual Studio or your favorite editor, add your new content or edit existi
|
|||
|
||||
#### New Samples
|
||||
|
||||
If making a new sample, you’ll want to create a new folder in the appropriate [Samples SDK folder](https://github.com/Microsoft/WindowsUIDevLabs/tree/master/SampleGallery/Samples) with a descriptive name. Copy the [sample template files](https://github.com/Microsoft/WindowsUIDevLabs/tree/master/SampleGallery/Samples/SampleTemplate) into your new folder and rename. You’ll also need to change the class names in both files, and add a good StaticSampleName and SampleDescription in the .cs file. The sample name should be short and match the intention of the sample; it will be the name displayed in the application. The description should be no more than a sentence and needs to concisely describe the purpose of the sample. It may also mention key APIs demonstrated.
|
||||
If making a new sample, you’ll want to create a new folder in the appropriate [Samples SDK folder](https://github.com/Microsoft/WindowsCompositionSamples/tree/master/SampleGallery/Samples) with a descriptive name. Copy the [sample template files](https://github.com/Microsoft/WindowsCompositionSamples/tree/master/SampleGallery/Samples/SampleTemplate) into your new folder and rename. You’ll also need to change the class names in both files, and add a good StaticSampleName and SampleDescription in the .cs file. The sample name should be short and match the intention of the sample; it will be the name displayed in the application. The description should be no more than a sentence and needs to concisely describe the purpose of the sample. It may also mention key APIs demonstrated.
|
||||
|
||||
References to the new files will need to be added to the [sample definition](https://github.com/Microsoft/WindowsUIDevLabs/blob/master/SampleGallery/Shared/SampleDefinition.cs) page in order for them to show up in the application. Please place the reference under the appropriate SDK version block check and fill in the necessary information.
|
||||
References to the new files will need to be added to the [sample definition](https://github.com/Microsoft/WindowsCompositionSamples/blob/master/SampleGallery/Shared/SampleDefinition.cs) page in order for them to show up in the application. Please place the reference under the appropriate SDK version block check and fill in the necessary information.
|
||||
|
||||
You’ll notice the sample definition takes an imageUrl to use as the sample icon in the application, which you should place in the [Assets/SampleThumbnails](https://github.com/Microsoft/WindowsUIDevLabs/tree/master/SampleGallery/Assets/SampleThumbnails) folder.
|
||||
You’ll notice the sample definition takes an imageUrl to use as the sample icon in the application, which you should place in the [Assets/SampleThumbnails](https://github.com/Microsoft/WindowsCompositionSamples/tree/master/SampleGallery/Assets/SampleThumbnails) folder.
|
||||
|
||||
#### Verifying Changes
|
||||
|
||||
|
@ -59,9 +59,9 @@ To validate your changes, make sure you run all samples you have touched on x64,
|
|||
|
||||
#### Submitting Pull Requests
|
||||
|
||||
After all changes have been committed and pushed to your branch, [create a pull request](https://github.com/Microsoft/WindowsUIDevLabs/compare). Please add a title and include a comment describing what changes have been made in detail. Double check that the Base branch is 'master' and your branch is the compared head.
|
||||
After all changes have been committed and pushed to your branch, [create a pull request](https://github.com/Microsoft/WindowsCompositionSamples/compare). Please add a title and include a comment describing what changes have been made in detail. Double check that the Base branch is 'master' and your branch is the compared head.
|
||||
|
||||
If creating a pull request to fix an existing open GitHub issue, please make sure to cross-reference the issue in the pull request and vice versa by using [supported GitHub issue and pull request autolinking](https://help.github.com/articles/autolinked-references-and-urls/). If no issue exists, please first [create a GitHub Issue](https://github.com/Microsoft/WindowsUIDevLabs/issues/new) then add the cross-referencing.
|
||||
If creating a pull request to fix an existing open GitHub issue, please make sure to cross-reference the issue in the pull request and vice versa by using [supported GitHub issue and pull request autolinking](https://help.github.com/articles/autolinked-references-and-urls/). If no issue exists, please first [create a GitHub Issue](https://github.com/Microsoft/WindowsCompositionSamples/issues/new) then add the cross-referencing.
|
||||
|
||||
Upon submitting the pull request, one of the site administrators will process it, review it, and provide feedback if necessary. Once all feedback is resolved, the pull request will be approved and integrated into the gallery.
|
||||
|
||||
|
@ -71,6 +71,6 @@ Alternative outlets for community participation are available through UserVoice,
|
|||
|
||||
The [UWP UserVoice site](https://wpdev.uservoice.com/forums/110705-universal-windows-platform/category/58517-xaml-controls-composition) can be used to vote on and create suggestions for improvements to the Windows developer platform. Suggestions are reviewed by the Windows platform developer team and your feedback is used for planning and understanding how developers use the platform.
|
||||
|
||||
This repo’s [GitHub Issues](https://github.com/Microsoft/WindowsUIDevLabs/issues) section can be used for asking questions about usage and bugs, but may also be used to respectfully interact with other community members to collaboratively answer questions and discover the innovative ways others are leveraging Windows APIs.
|
||||
This repo’s [GitHub Issues](https://github.com/Microsoft/WindowsCompositionSamples/issues) section can be used for asking questions about usage and bugs, but may also be used to respectfully interact with other community members to collaboratively answer questions and discover the innovative ways others are leveraging Windows APIs.
|
||||
|
||||
Finally, StackOverflow has an active community of Windows UI developers where you can ask questions. Tag with ['uwp'](https://stackoverflow.com/questions/tagged/uwp) (or your appropriate application architecture), and tags indicating your framework. Some known active tags for Composition include ['windows-composition-api'](https://stackoverflow.com/questions/tagged/windows-composition-api?mixed=1) and ['xaml-composition'](https://stackoverflow.com/questions/tagged/xaml-composition?mixed=1).
|
||||
Finally, StackOverflow has an active community of Windows UI developers where you can ask questions. Tag with ['uwp'](https://stackoverflow.com/questions/tagged/uwp) (or your appropriate application architecture), and tags indicating your framework. Some known active tags for Composition include ['windows-composition-api'](https://stackoverflow.com/questions/tagged/windows-composition-api?mixed=1) and ['xaml-composition'](https://stackoverflow.com/questions/tagged/xaml-composition?mixed=1).
|
||||
|
|
Загрузка…
Ссылка в новой задаче