-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
327cf62
commit 82e2b2e
Showing
2 changed files
with
83 additions
and
3 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# Guide to Codebase Change Markers | ||
|
||
Whenever you change a file not owned by this codebase you need to clarify which portions have been changed. If the markers described below don't have a description for the file type you're working with, don't add a marker yet and ask a reviewer if you need one and how it should be done. | ||
|
||
The following is the formatting for annotations per language type: | ||
|
||
|
||
### C# | ||
|
||
Single line changes: | ||
|
||
```csharp | ||
<Rest of the unchanged file above...> | ||
[Your code here. This can be entirely original or modified from the original file] // Parkstation-[TitleOfFeature] - Optional clarification of change | ||
<Rest of the unchanged file below...> | ||
``` | ||
|
||
Multiple line changes: | ||
|
||
```csharp | ||
<Rest of the unchanged file above...> | ||
// Parkstation-[TitleOfFeature]-Start - Optional clarification of change | ||
[Your code here. This can be entirely original or modified from the original file] | ||
// Parkstation-[TitleOfFeature]-End | ||
<Rest of the unchanged file below...> | ||
``` | ||
|
||
|
||
### XAML | ||
|
||
Single line changes: | ||
|
||
```xaml | ||
<Rest of the unchanged file above...> | ||
<!-- Parkstation-[TitleOfFeature] - Optional clarification of change --> | ||
[Your code here. This can be entirely original, or modified from the original file] | ||
<Rest of the unchanged file below...> | ||
``` | ||
|
||
Multiple line changes: | ||
|
||
```xaml | ||
<Rest of the unchanged file above...> | ||
<!-- Parkstation-[TitleOfFeature]-Start - Optional clarification of change --> | ||
[Your code here. This can be entirely original, or modified from the original file] | ||
<!-- Parkstation-[TitleOfFeature]-End --> | ||
<Rest of the unchanged file below...> | ||
``` | ||
|
||
|
||
|
||
### YML | ||
|
||
Single line changes: | ||
|
||
```yml | ||
<Rest of the unchanged file above...> | ||
[Your code here. This can be entirely original, or modified from the original file] # Parkstation-[TitleOfFeature] - Optional clarification of change | ||
<Rest of the unchanged file below...> | ||
``` | ||
|
||
Multiple line changes: | ||
|
||
```yml | ||
<Rest of the unchanged file above...> | ||
# Parkstation-[TitleOfFeature]-Start - Optional clarification of change | ||
[Your code here. This can be entirely original, or modified from the original file] | ||
# Parkstation-[TitleOfFeature]-End | ||
<Rest of the unchanged file below...> | ||
``` | ||
|
||
|
||
### Never Needed | ||
|
||
- MD | ||
- TXT | ||
- XML | ||
- JSON | ||
- RGA (Robust Generic Attribution, specifies asset licenses) | ||
- PNG (Licensed differently) | ||
- OGG (Licensed differently) |
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