Skip to content

Commit 3d92a7a

Browse files
author
Shreyas Padhye
committed
Added Contribution Guide
1 parent 73c8d7c commit 3d92a7a

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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+
Please note we have a [code of conduct](https://microsoft.github.io/codeofconduct/), please follow it in all your interactions with the project.
5+
6+
## Pull Request Process
7+
1. Fork repository and create your feature branch out of master.
8+
2. Open [Codegen project](./package/Codegen/Codegen.csproj) in Visual Studio.
9+
3. Right click on project in solution explorer -> select "Manage Nuget Packages". This should open the NuGet Manager which will prompt you to restore NuGet packages. Click on "Restore". Once you restore the packages, the project is ready to build / run.
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+
17+
## Technical details:
18+
You can find more details to setting up in the [Technical Guide](TechnicalGuide.md).

0 commit comments

Comments
 (0)