MilonPL: Protected "Delta-V:Contribution guidelines": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2024-11-05T18:21:10Z

Protected "Delta-V:Contribution guidelines": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 14:21, 5 November 2024
(No difference)

MilonPL: Created page with "= Delta-V Contributing Guidelines = Generally we follow [https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html upstream's PR guidelines] for code quality and such. Upstream is the [https://github.com/space-wizards/space-station-14 space-wizards/space-station-14] repository that wizden runs on. Importantly do not make webedits, copied verbatim from above:
'''Do not use GitHub's web editor to create PRs. PRs submitted throu..."

2024-11-05T18:20:37Z

Created page with "= Delta-V Contributing Guidelines = Generally we follow [https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html upstream's PR guidelines] for code quality and such. Upstream is the [https://github.com/space-wizards/space-station-14 space-wizards/space-station-14] repository that wizden runs on. Importantly do not make webedits, copied verbatim from above: <br> '''Do not use GitHub's web editor to create PRs. PRs submitted throu..."

New page

= Delta-V Contributing Guidelines =
Generally we follow [https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html upstream's PR guidelines] for code quality and such.
Upstream is the [https://github.com/space-wizards/space-station-14 space-wizards/space-station-14] repository that wizden runs on.

Importantly do not make webedits, copied verbatim from above: <br>
'''Do not use GitHub's web editor to create PRs. PRs submitted through the web editor may be closed without review.'''

= Content specific to Delta-V =
In general anything you create from scratch (not modifying something that exists from upstream) should go in a DeltaV subfolder.
Examples:

*<code>Content.Server/DeltaV/Chapel/SacrificialAltarSystem.cs</code>
*<code>Resources/Prototypes/DeltaV/ai_factions.yml</code>
*<code>Resources/Audio/DeltaV/Items/gavel.ogg</code>
*<code>Resources/Textures/DeltaV/Icons/cri.rsi</code>
*<code>Resources/Locale/en-US/deltav/shipyard/shipyard-console.ftl</code>
** The locale subfolder is lowercase <code>deltav</code> instead of <code>DeltaV</code>.
*<code>Resources/ServerInfo/Guidebook/DeltaV/AlertProcedure.xml</code>
** Note that guidebooks go in <code>ServerInfo/Guidebook/DeltaV</code> and not <code>ServerInfo/DeltaV</code>!

= Changes to upstream files =
If you make a change to an upstream C# or YAML file '''you must add comments on or around the changed lines'''.
The comments should clarify what changed, to make conflict resolution simpler when a file is changed upstream.

For YAML specifically, if you add a new component to a prototype add the comment to the <code>type: ...</code> line.
If you just modify some fields of a component, comment the fields instead.

For C# files, if you are adding a lot of code try to put it in a partial class when it makes sense.

The exception to this is early merging commits that are going to be cherry picked in the future regardless, there's no harm in leaving them as-is.

As an aside, fluent (.ftl) files '''do not support comments on the same line''' as a locale value, so be careful when changing them.
== Examples of comments in upstream files ==
A single line comment on a changed yml field:
<syntaxhighlight lang="yaml">
- type: entity
parent: BasePDA
id: SciencePDA
name: epistemics PDA # DeltaV - Epistemics Department replacing Science
</syntaxhighlight>

A pair of comments enclosing a list of added items to starting gear:
<syntaxhighlight lang="yaml">
storage:
back:
- EmergencyRollerBedSpawnFolded
# Begin DeltaV additions
- BodyBagFolded
- Portafib
# End DeltaV additions
</syntaxhighlight>
A comment on a new imported namespace:
<syntaxhighlight lang="csharp">
using Content.Server.Psionics.Glimmer; // DeltaV
</syntaxhighlight>
A pair of comments enclosing a block of added code:
<syntaxhighlight lang="csharp">
private EntityUid Slice(...)
{
...

_transform.SetLocalRotation(sliceUid, 0);

// DeltaV - start of deep frier stuff
var slicedEv = new FoodSlicedEvent(user, uid, sliceUid);
RaiseLocalEvent(uid, ref slicedEv);
// DeltaV - end of deep frier stuff

...
}
</syntaxhighlight>

= Mapping =
If you want to make changes to a map, get in touch with its maintainer to make sure you don't both make changes at the same time.

Conflicts with maps make PRs mutually exclusive so either your work on the maintainer's work will be lost, communicate to avoid this!

= Before you submit =

Double-check your diff on GitHub before submitting: look for unintended commits or changes and remove accidental whitespace or line-ending changes.

Additionally for long-lasting PRs, if you see <code>RobustToolbox</code> in the changed files you have to revert it, use <code>git checkout upstream/master RobustToolbox</code> (replacing <code>upstream</code> with the name of your DeltaV-Station/Delta-V remote)

= Changelogs =
By default any changelogs goes in the DeltaV changelog, you can use the DeltaV admin changelog by putting <code>DELTAVADMIN:</code> in a line after <code>:cl:</code>.

Do not use <code>ADMIN:</code> as '''it will mangle''' the upstream admin changelog!

= Additional resources =
If you are new to contributing to SS14 in general, have a look at the [https://docs.spacestation14.io/ SS14 docs] or ask for help in <code>#contribution-help</code> on [https://discord.gg/deltav Discord]!

Delta-V:Contribution guidelines - Revision history

MilonPL: Protected "Delta-V:Contribution guidelines": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))