Skip to content

Commit

Permalink
create MARKERS, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
DEATHB4DEFEAT committed Mar 10, 2024
1 parent 327cf62 commit 82e2b2e
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 3 deletions.
81 changes: 81 additions & 0 deletions MARKERS.md
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)
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,9 @@ Refer to [the Space Wizards' guide](https://docs.spacestation14.com/en/general-d
## License

Content contributed to this repository after commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the GNU Affero General Public License version 3.0 unless otherwise stated. See [LICENSE-AGPLv3](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-AGPLv3.txt).
Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the MIT license unless otherwise stated. See [LICENSE-MIT](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-MIT.txt).
Content contributed to this repository after commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 (`17 February 2024 23:00:00 UTC`) is licensed under the GNU Affero General Public License version 3.0 unless otherwise stated. See [LICENSE-AGPLv3](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-AGPLv3.txt).

[87c70a89a67d0521a56388e6b1c3f2cb947943e4](https://github.com/DeltaV-Station/Delta-v/commit/87c70a89a67d0521a56388e6b1c3f2cb947943e4) was pushed on February 17th 2024 at 21:48 UTC
Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 (`17 February 2024 23:00:00 UTC`) is licensed under the MIT license unless otherwise stated. See [LICENSE-MIT](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-MIT.txt).

Most assets are licensed under [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) unless stated otherwise. Assets have their license and the copyright in the metadata file. [Example](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/Resources/Textures/Objects/Tools/crowbar.rsi/meta.json).

Expand Down

0 comments on commit 82e2b2e

Please sign in to comment.