Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#1200)
Browse files Browse the repository at this point in the history
Add `addUsesTo` section under enums
  • Loading branch information
elachlan authored Aug 31, 2022
1 parent a288c9a commit eb0f857
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ Enums are defined in [enums.json](generation/WinSDK/enums.json). This file provi
* `type` - Optional property indicating the type for the enum
* Note: If omitted, the default value is `uint`
* `name` - The name of the enum
* `addUsesTo` - The name of an existing enum scraped from the headers, specify this value to add additional uses to the enum.
* `flags` - Whether this is a flags enum
* `autoPopulate` - For automatically defined members, rules for how to populate them
* `header` - The header to scan
Expand Down Expand Up @@ -199,4 +200,4 @@ When validating changes, it's important to evaluate the diffs to ensure all chan

Additionally, it is useful to load the winmd in [ILSpy](https://github.com/icsharpcode/ILSpy) and navigate through the APIs as another means to identify additional changes that may be required to achieve the desired end result. You may notice that two related APIs are in different namespaces or that a type that an API depends on was not moved as you would have expected. If that happens, search the repo for the API or its header file to identify where it may be being mapped to another namespace.

Once all the changes are validated, update the list of known changes since the last release by following the steps reported in the build output. When a new release is made, the list of changes in [ChangesSinceLastRelease.txt](scripts/ChangesSinceLastRelease.txt) will get reset and will start accumulating again until the next release.
Once all the changes are validated, update the list of known changes since the last release by following the steps reported in the build output. When a new release is made, the list of changes in [ChangesSinceLastRelease.txt](scripts/ChangesSinceLastRelease.txt) will get reset and will start accumulating again until the next release.

0 comments on commit eb0f857

Please sign in to comment.