Delta-v/MARKERS.md

46 lines
1.3 KiB
Markdown

# A quick summary of how to mark code files in this repository
## CSharp
All C# code contributed after 17 February, 2024 23:00:00 UTC should contain the following header:
```csharp
/*
* Delta-V - This file is licensed under AGPLv3
* Copyright (c) [Year] Delta-V Contributors
* See AGPLv3.txt for details.
*/
```
For any changes within MIT licensed(upstream) files, the following marker should be used at the start of the modification
```csharp
/* DeltaV - [Title of changes] - [Description of changes]
This code is licensed under AGPLv3. See AGPLv3.txt */
yourCodeHere();
// End of modified code
```
## Yaml
All Yaml files contributed after 17 February, 2024 23:00:00 UTC should contain the following header:
```yaml
# Delta-V - This file is licensed under AGPLv3
# Copyright (c) [Year] Delta-V Contributors
# See AGPLv3.txt for details.
```
For any changes within MIT licensed(upstream) files, the following marker should be used at the start of the modification
```yaml
# DeltaV - [Title of changes] - [Description of changes]
# This code is licensed under AGPLv3. See LICENSE
modifiedYaml: "Goes Here"
# End of modified code
```
## Note
Both Space Wizards and Nyanotrasen code is licensed under MIT, and any changes made to their code should be marked as AGPLv3 with the above markers.