Skip to content

Commit ceed6ab

Browse files
authored
Merge pull request #183 from shreyaspadhye3011/contributing
Added Contribution Guide
2 parents 4a64de4 + 99b3a9d commit ceed6ab

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
3+
4+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
5+
6+
## Pull Request Process
7+
1. Fork repository and create your feature branch out of main.
8+
2. Open [Codegen project](./package/Codegen/Codegen.csproj) in Visual Studio.
9+
3. Build project (this will restore NuGet packages). Once completed, you are ready to run the project, see output, and make your desired changes.
10+
4. If you make changes in a .tt file, all you need to do is save the file and that will generate corresponding files that reflect your change.
11+
5. For all other changes: run `yarn build` in src folder so that related files are generated
12+
6. Run from Visual Studio to see output.
13+
7. Once changes are ready, run `yarn change` at the root of the repository to create a patch (it will ask for a description of the change). The version scheme we use is [SemVer](https://semver.org/)
14+
8. Open a pull request and address review feedback.
15+
16+
## Technical details:
17+
You can find more details to setting up in the [Technical Guide](TechnicalGuide.md).

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,12 @@ To see examples of the syntax and available controls, check out the [Usage guide
1414
react-native-xaml works by leveraging metadata for XAML properties, types and events. This metadata is automatically generated ([code-gen](https://github.com/asklar/react-native-xaml/tree/main/package/Codegen)) from the Windows SDK.
1515
This means we can have a full projection of all of XAML – or any WinRT components written by app devs, that export a [UserControl](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.UserControl) – without manual intervention.
1616

17-
## Technical details:
17+
## Technical details
1818
See [Technical Guide](TechnicalGuide.md).
1919

20+
## Contributing
21+
Pull Requests are welcome. See [Contribution Guide](CONTRIBUTING.md) for details.
22+
2023
## Demo
2124

2225
![react-native-xaml demo](https://raw.githubusercontent.com/asklar/react-native-xaml/main/example/rnx.gif)

0 commit comments

Comments
 (0)