Skip to content

Commit

Permalink
Template changes (#562)
Browse files Browse the repository at this point in the history
  • Loading branch information
dffdff2423 authored Mar 5, 2025
1 parent 0bdf51b commit 7652549
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 23 deletions.
27 changes: 4 additions & 23 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,7 @@
<!-- The text between the arrows are comments - they will not be visible on your PR. -->

## About the PR
<!-- What did you change in this PR? -->

## Why / Balance
<!-- Why was it changed? Link any discussions or issues here. Please discuss how this would affect game balance. -->

## Technical details
<!-- If this is a code change, summarize at high level how your new code works. This makes it easier to review. -->
<!-- What did you change in this PR and why did you do it? -->

## Media
<!--
Expand All @@ -20,26 +14,13 @@ If you're unsure whether your PR will require media, ask a maintainer.
-->

## Requirements
<!--
Due to influx of PR's we require to ensure that PR's are following the correct guidelines.

Please take a moment to read these if its your first time.
Check the boxes below to confirm that you have in fact seen these (put an X in the brackets, like [X]):
-->
- [ ] I have read and I am following the [Pull Request Guidelines](https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html). I understand that not doing so may get my pr closed at maintainer’s discretion
- [ ] I have read and I am following the Cosmatic Drift [PR Guidelines](https://github.com/cosmatic-drift-14/cosmatic-drift/blob/master/CONTRIBUTING.md) (note that they may differ than what you find on other SS14 forks).
- [ ] I have approval from a maintainer if this PR adds a feature OR this PR does not add a feature OR you are alright with this PR being closed at a maintainer's discression.
- [ ] I have added screenshots/videos to this PR showcasing its changes ingame, **or** this PR does not require an ingame showcase

## Breaking changes
<!--
List any breaking changes, including namespace, public class/method/field changes, prototype renames; and provide instructions for fixing them. This will be pasted in #codebase-changes.
-->

**Changelog**
<!--
Make players aware of new features and changes that could affect how they play the game by adding a Changelog entry. Please read the Changelog guidelines located at: https://docs.spacestation14.io/en/getting-started/pr-guideline#changelog
We do not have the bot upstream uses to automatically create changelogs. Simply write a summery of your changes to be
listed in #progress-reports. If you would like to be credited as something other then you github username please include the
name that you would like to be credited as.
listed in #progress-reports. If you would like to be credited as something other then you github username please include the name that you would like to be credited as.
-->
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,13 @@ All contributions must be placed under the `_CD` namespace where appropriate. Fo
typically a subdirectory called `_CD`. For C# changes, there is a C# namespace under almost every `Content.*` folder. If
one does not exist, feel free to make one.

**Content ported from other servers should be moved to the CD namespace**

Changes to wizden code should be clearly marked with a comment. For one line changes this typically takes the form of `#
CD: why you changed it`. Larger changes are typically located between the comments.

Wizden database tables should not be touched. Instead create another table that containes all CD related information that is a optional 1:1 relationship with the wizden table. See `CDModel` for more information. This is a workaround for [an EF Core bug](https://github.com/dotnet/efcore/issues/24834).

Some old code does not follow these guidelines. If you are modifying it, please try to bring it up to our modern
standards.

Expand All @@ -44,3 +48,16 @@ Before you work on a medium to large PR please ask the maintainers on discord if
it. This is to prevent you from wasting your time working on something that would not get merged. For large PRs we would
prefer if you would create a design document outlining your changes. You can do this as a discord thread or a github
issue. Github issues are preferred.

### Licensing

All content must be clearly identifiable as a license that we accept. If it is not, you need to reach out and get a written statement from the author that we are alright to use it under the terms of one of the licenses that we do accept. Ask a Project Lead before including content with a license not on this list.

We accept the following licenses:
- MIT (and similar licenses)
- MPL 2.0 (without Exhibit B)
- Public Domain equivalent licenses
- CC-BY-SA (or anything from CC that is less restrictive)
- CC-BY-SA-NC (note that this is not preferred for the reasons outlined [here](https://github.com/cosmatic-drift-14/cosmatic-drift/pull/549#discussion_r1976817869))

We do not accept code under any version of the GNU GPL or AGPL. These licenses are used by a few space station forks. We would need a statement from the author stating that we are allowed to use it under a license on the above list if you intend to port code from a (A)GPL fork.

0 comments on commit 7652549

Please sign in to comment.