You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/CONTRIBUTING.md
+26-5
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,8 @@ CONTRIBUTING
10
10
4. Code Standards
11
11
5. Codebase-specific Policies
12
12
6. Asset Policy
13
-
7. Banned Content
13
+
7. Pull Request Standards
14
+
8. Banned Content
14
15
15
16
## 1. Introduction
16
17
Hello and welcome to BeeStation's contributing page. You are presumably here because you are interested in contributing - thank you! Everyone is free to contribute to this project as long as they follow the simple guidelines and specifications below; at BeeStation, we strive to maintain code stability and maintainability, and to do that, we need all pull requests to meet our standards. It's in everyone's best interests - including yours!
@@ -38,12 +39,15 @@ You can of course, as always, ask for help on our discord.
38
39
39
40
## 3. Recommended Tools - Creating a Decent Dev Environment
40
41
41
-
By default, the only thing BYOND provides people with is Dream Maker. It is hardly sufficient, and few (if any) contributors regularly use it. Instead, we have a variety of alternative tools for different purposes that make our lives a lot easier:
42
+
**Important:** Using Dream Maker to write code is not supported and will cause problems. All coding needs to be done in VSCode with the recommended extension(s).
43
+
44
+
In addition to VSCode, several other tools exist to make your life easier.
* Code editing - [VSCode](https://code.visualstudio.com/) (NOT THE SAME AS VISUAL STUDIO)
45
-
* VSCode Extensions - [DM syntax highlighting](https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support), [DM language support](https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient)
46
-
* Map editing - [FastDMM2](https://fastdmm2.ss13.io/) or [StrongDMM](https://github.com/SpaiR/StrongDMM)
48
+
* VSCode Extensions - You will be prompted to install this recommended extension automatically: [Goonstation Extension Pack](https://marketplace.visualstudio.com/items?itemName=Goonstation.goonstation-extpack)
49
+
* Map editing - [StrongDMM](https://github.com/SpaiR/StrongDMM) or [FastDMM2](https://fastdmm2.ss13.io/). Dream Maker works but requires additional steps for SS13 that these automate.
50
+
* Icon editing - Dream Maker or your image editor of choice. Any PNG can be imported into Dream Maker.
47
51
48
52
## 4. Code Standards
49
53
There are a variety of ways you can write valid DM code. However, BeeStation is not as lenient. Maintaining good code standards is important for performance and readability reasons. You can find details about our code standards [here](https://github.com/BeeStation/BeeStation-Hornet/wiki/Code-Standards).
@@ -53,6 +57,9 @@ They are mostly the same as /tg/station's code standards, though we are not quit
53
57
Failure to meet these standards can result in your pull request being closed. The code standards are non-exhaustive and Maintainers have the final say.
54
58
55
59
## 5. Codebase-specific Policies
60
+
### CEV-Eris
61
+
Sprites from CEV-Eris and sprites clearly inspired by their art style are generally not permitted unless you recolor them using a tolerable color palette.
62
+
56
63
### HippieStation
57
64
HippieStation's code standards are much more lax than BeeStation. Their code typically does not meet our standards. Therefore, you should not attempt to port code from HippieStation unless you have the experience and knowledge necessary to rewrite the code to our standards. Maintainers will not hold your hand for this, instead they will simply close the pull request.
58
65
@@ -90,7 +97,21 @@ If you are adding new assets that are not already explicitly licensed under CC-B
90
97
91
98
If at any point you are confused or unsure of an asset's license or our policy, ask a Maintainer to help you.
92
99
93
-
## 7. Banned Content
100
+
## 7. Pull Request Standards
101
+
102
+
You should complete the pull-request template in its entirety.
103
+
104
+
Any pull-request that does not adequately complete the provided template may be closed or marked 'do not merge' by maintainers.
105
+
- Any changes that may affect game balance should be documented as a balance change. This also applies to bug fixes which directly alter the game's balance.
106
+
- Changes must be documented in their entirety including the extent of their effects. (For example, if you change it so all mobs are half speed, don't label the PR as 'monkeys now move twice as slow'). Failing to document the full extent of the changes may result in a repo-ban if the intent of hiding changes is seen as malicious.
107
+
- The section labeled 'about this pull request' should describe the pull request's changes in detail. This includes the changes being made, any important details about how it was implemented, the issues it closes, and links to any other pull requests if code is being ported from another codebase.
108
+
- The section labeled "why it's good for the game" should include the reasons behind the changes and how they will be good for the game.
109
+
- The testing section should contain screenshots, videos, and/or reproducible testing procedures showing that the PR works as specified. Pull-requests that ignore this section, or are not tested, may be closed by maintainers. This applies to small PRs that may seem trivial.
110
+
- The changelog should include a short summary of the changes made. If your pull request includes things made by other people, you should list everybody who contributed, including yourself, after the :cl: tag.
111
+
112
+
If a pull-request requires updates to the wiki, these changes should be made on your user account page (For example: https://wiki.beestation13.com/view/User:PowerfulBacon), so that the original page can be updated on merge.
113
+
114
+
## 8. Banned Content
94
115
95
116
Do not add any of the following in a Pull Request or risk getting the PR closed:
Copy file name to clipboardexpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+11-1
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,17 @@
7
7
8
8
## Why It's Good For The Game
9
9
10
-
<!-- Please add a short description of why you think these changes would benefit the game. If you can't justify it in words, it might not be worth adding. -->
10
+
<!-- Please add a short description of why you think these changes would benefit the game. If you can't justify it in words, it might not be worth adding.
11
+
-->
12
+
13
+
## Testing Photographs and Procedure
14
+
<!-- Include any screenshots/videos/debugging steps of the modified code functioning successfully, ideally including edge cases. -->
15
+
<details>
16
+
<summary>Screenshots&Videos</summary>
17
+
18
+
Put screenshots and videos here with an empty line between the screenshots and the `<details>` tags.
Copy file name to clipboardexpand all lines: .github/workflows/stale_prs.yml
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,5 +15,5 @@ jobs:
15
15
stale-pr-message: "This PR has been inactive for long enough to be automatically marked as stale. This means it is at risk of being closed by a maintainer if it is not updated or reviews are not addressed. If your PR is closed as stale, feel free to open a new one after dealing with the issues. This may also be an indication that the maintainers do not have interest in this change, you can try to convince them otherwise, or persist in the doomed world you have created."
0 commit comments