cyberpresidentvanellope/fulpstation
1
0
Fork 0
mirror of https://github.com/fulpstation/fulpstation.git synced 2025-12-10 01:57:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md for tgui-next (#47119)

Browse Source 
This PR updates CONTRIBUTING.md to account for tgui-next. This is to 
make sure that new contributors know not to PR raw HTML or old TGUI 
interfaces.
This commit is contained in:
81Denton
2019-10-22 04:39:56 +02:00
committed by Tad Hardesty
parent eaf9408b4b
commit ba35902944
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.github/CONTRIBUTING.md vendored
View File

@@ -257,6 +257,12 @@ This prevents nesting levels from getting deeper then they need to be.
* Please attempt to clean out any dirty variables that may be contained within items you alter through var-editing. For example, due to how DM functions, changing the `pixel_x` variable from 23 to 0 will leave a dirty record in the map's code of `pixel_x = 0`. Likewise this can happen when changing an item's icon to something else and then back. This can lead to some issues where an item's icon has changed within the code, but becomes broken on the map due to it still attempting to use the old entry.
* Areas should not be var-edited on a map to change it's name or attributes. All areas of a single type and it's altered instances are considered the same area within the code, and editing their variables on a map can lead to issues with powernets and event subsystems which are difficult to debug.
### User Interfaces
* All new player-facing user interfaces must use TGUI-next; TGUI is deprecated.
* Raw HTML is permitted for admin and debug UIs.
* Documentation for TGUI-next can be found at:
* [tgui-next/README.md](../tgui-next/README.md)
* [tgui-next/tutorial-and-examples.md](../tgui-next/docs/tutorial-and-examples.md)
### Other Notes
* Code should be modular where possible; if you are working on a new addition, then strongly consider putting it in its own file unless it makes sense to put it with similar ones (i.e. a new tool would go in the "tools.dm" file)