Difference between revisions of "Getting Your Pull Accepted"
imported>Rockdtben (Created page with "So you've made a change to the code/sprites and want to make a Pull Request so we can add it to the game. Before you do this, though, we have some requirements so your code d...") |
Covertcorvid (talk | contribs) (→Pull Request Requirements: Added sections about porting upstream and GitHub overrides) |
||
| (42 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| − | So you've made a change to the code/sprites and want to make a Pull Request so | + | So you've made a change to the code/sprites and want to make a Pull Request so it can be added to the game! |
| − | Before you do this, though, | + | Before you do this, though, there are have some requirements so your code doesn't make SS13's infamous spaghetti code problems even worse. Make sure your code fits these requirements or your pull will not be accepted. You may also want to read through the suggestions section. |
| + | = Pull Request Requirements = | ||
| + | === 1. You must follow the coding standards === | ||
| + | Please read through these [[Coding Standards]]. The standards will change over time. Hopefully you already read through and made sure your code adhered to them before opening your pull request! | ||
| + | === 2. Your code must compile. === | ||
| + | This is a given. While your pull request will not be closed over this, it will not be accepted until it does compile cleanly. The [https://travis-ci.org/tgstation/-tg-station Travis] bot will check for this automatically, but you should check before you even commit. Warnings should also be cleared. | ||
| − | + | Sometimes Travis is a silly bot and something unrelated to your code causes his compile to fail. If this happens you can force a rebuild by closing and reopening your pull request. Alternatively, you can ask a maintainer to force a rebuild from the Travis page (must be logged in). | |
| − | === | + | If you change an object's path, you must update any maps that have that item placed on it. Travis checks all maps, including Ministation and Metastation. If Travis is failing you after a path change and you don't know why, check the other maps! |
| − | + | === 3. Do not automatically add FILE_DIR. === | |
| + | A recurring problem is people adding commits that needlessly spam changes to the DME due to having "Automatically add FILE_DIR" set in their project settings. You'll know if you have this problem if you see this in your commit (as seen through github): | ||
| + | [[Image:Fucking_FILE_DIR.png|600px|center]] | ||
| + | PRs that add things to FILE_DIR will be rejected. | ||
| + | |||
| + | To fix this problem: | ||
| + | # Open up DreamMaker | ||
| + | # Build > Preferences for tgstation.dme... | ||
| + | # '''Uncheck''' "Automatically set FILE_DIR for sub-directories" | ||
| + | # Check compile. | ||
| + | # Close DreamMaker and commit again. | ||
| + | === 4. Pull requests must be atomic === | ||
| + | Pull requests must add, remove, or change only ONE feature or related group of features. Do not "bundle" together a bunch of things, as each change may be controversial and hold up everything else. In addition, it's simply neater. | ||
| − | + | Bugfix-only PRs are granted some leniency, however not all bugfixes are made equal. It's possible to have a change that technically fixes a bug, but does so in a way that's hacky or otherwise undesirable. | |
| + | === 5. Make explicit commit logs === | ||
| + | Be clear in exactly what each of your commits do. Esoteric or jokey commit logs are hard for future coders to interpret which makes tracing changes harder. Don't make it too long however since an actual description of your changes goes into your pull request's comment. Ideally the first line should be a short summary, then you have a more fleshed out commentary below that. | ||
| − | + | Make sure you also add a changelog entry if you're making a big player facing change. | |
| + | The guide to adding changelogs can be found in the [[Guide_to_Changelogs]] | ||
| + | === 6. Clearly state what your pull request does === | ||
| + | Don't withhold information about your pull request. This will get your pull request delayed, and if it happens too often your pull request will be closed. | ||
| − | + | Suppose you fixed bug #1234 and changed the name and description of an item as a gag. | |
| − | |||
'''Bad:''' | '''Bad:''' | ||
<pre> | <pre> | ||
| − | + | In this PR I fixed bug #1234. | |
| − | |||
| − | |||
| − | |||
| − | |||
</pre> | </pre> | ||
| − | |||
'''Acceptable:''' | '''Acceptable:''' | ||
<pre> | <pre> | ||
| − | + | In this PR I fixed bug #1234 and also modified the baton's name and description. | |
| − | |||
| − | |||
| − | |||
</pre> | </pre> | ||
| − | + | === 7. Upstream Compatibility === | |
| + | NSV tries to maintain compatibility with our upstream and host, BeeStation, when possible. If your code only changes core files, not NSV-specific mechanics, consider making an upstream pull request. BeeStation requires pre-approval by a maintainer before opening any species-related pull requests. | ||
| − | + | Code will not be automatically rejected if not ported upstream, but our maintainers may ask you to port it as good practice. If this happens, please leave a comment to tell us whether you will be porting it, or mention the NSV pull request in the BeeStation one so that GitHub links them together. Large PRs of this nature that are ported upstream are '''more likely''' to be approved (see the coding standards sections on modular code and bloated code). If the PR is not ported upstream it is up to our staff to decide whether the feature is worth it. | |
| − | |||
| − | |||
| − | ''' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | If your upstream PR is rejected or you decide to close it, but still want the PR to be considered on NSV, please also let us know that with a comment for faster response time. We will check the overall status occasionally, but do not closely monitor the progress of upstream PRs. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | === 8. The balance of power === | |
| + | While maintainer requests are often good to follow, your PR can still be merged with a change request on it. Repository staff have the ability to dismiss change requests, and leads can bypass normal merge requirements for approval. Leave us a comment or a discord note if you need a second opinion or have questions about whether something is a requirement or just a desirement. | ||
| − | == | + | == How to Deal with Merge Conflicts == |
| − | + | Most of the time, Git is pretty smart about merging code files. However, if one PR is merged before yours that edits the same file, your PR will be in a state of conflict and will not be able to be automatically merged via GREEN BUTTON. Because there are more contributors than there are maintainers, most of the time resolving these conflicts falls to the maker of the PR. | |
| − | + | An easy way to fix merge conflicts is to make a new branch (you should especially do this if your PR is just a small one): | |
| + | # Switch to your master branch: Right-click your working folder, go '''TortoiseGit''' --> '''Git Switch/Checkout...''' | ||
| + | # Look at the '''Branch'''-list and select '''master''' | ||
| + | # Close the window that pops up (assuming it changed successfully) | ||
| + | # Right-click your working folder, go '''TortoiseGit''' --> '''Git Pull...''' | ||
| + | # On the top, from the '''Remote'''-list, select '''upstream''' and from the '''Remote Branch''' -list select '''master'''. | ||
| + | # Close the window that pops up (assuming it updated successfully) | ||
| + | # Make the same exact changes to the code which you have on your PR | ||
| + | # Commit and MAKE A NEW BRANCH | ||
| + | # Push your new branch to your PR branch, and tick '''Force: unknown changes''' | ||
| − | |||
| − | + | If it's a map file that's conflicted, remember to start the [[Map Merger]] before you pull from upstream. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | {{Contribution guides}} | |
| + | [[Category:Game Resources]] [[Category:Guides]] | ||
Latest revision as of 00:09, 30 March 2023
So you've made a change to the code/sprites and want to make a Pull Request so it can be added to the game!
Before you do this, though, there are have some requirements so your code doesn't make SS13's infamous spaghetti code problems even worse. Make sure your code fits these requirements or your pull will not be accepted. You may also want to read through the suggestions section.
Pull Request Requirements[edit | edit source]
1. You must follow the coding standards[edit | edit source]
Please read through these Coding Standards. The standards will change over time. Hopefully you already read through and made sure your code adhered to them before opening your pull request!
2. Your code must compile.[edit | edit source]
This is a given. While your pull request will not be closed over this, it will not be accepted until it does compile cleanly. The Travis bot will check for this automatically, but you should check before you even commit. Warnings should also be cleared.
Sometimes Travis is a silly bot and something unrelated to your code causes his compile to fail. If this happens you can force a rebuild by closing and reopening your pull request. Alternatively, you can ask a maintainer to force a rebuild from the Travis page (must be logged in).
If you change an object's path, you must update any maps that have that item placed on it. Travis checks all maps, including Ministation and Metastation. If Travis is failing you after a path change and you don't know why, check the other maps!
3. Do not automatically add FILE_DIR.[edit | edit source]
A recurring problem is people adding commits that needlessly spam changes to the DME due to having "Automatically add FILE_DIR" set in their project settings. You'll know if you have this problem if you see this in your commit (as seen through github):
PRs that add things to FILE_DIR will be rejected.
To fix this problem:
- Open up DreamMaker
- Build > Preferences for tgstation.dme...
- Uncheck "Automatically set FILE_DIR for sub-directories"
- Check compile.
- Close DreamMaker and commit again.
4. Pull requests must be atomic[edit | edit source]
Pull requests must add, remove, or change only ONE feature or related group of features. Do not "bundle" together a bunch of things, as each change may be controversial and hold up everything else. In addition, it's simply neater.
Bugfix-only PRs are granted some leniency, however not all bugfixes are made equal. It's possible to have a change that technically fixes a bug, but does so in a way that's hacky or otherwise undesirable.
5. Make explicit commit logs[edit | edit source]
Be clear in exactly what each of your commits do. Esoteric or jokey commit logs are hard for future coders to interpret which makes tracing changes harder. Don't make it too long however since an actual description of your changes goes into your pull request's comment. Ideally the first line should be a short summary, then you have a more fleshed out commentary below that.
Make sure you also add a changelog entry if you're making a big player facing change. The guide to adding changelogs can be found in the Guide_to_Changelogs
6. Clearly state what your pull request does[edit | edit source]
Don't withhold information about your pull request. This will get your pull request delayed, and if it happens too often your pull request will be closed.
Suppose you fixed bug #1234 and changed the name and description of an item as a gag.
Bad:
In this PR I fixed bug #1234.
Acceptable:
In this PR I fixed bug #1234 and also modified the baton's name and description.
7. Upstream Compatibility[edit | edit source]
NSV tries to maintain compatibility with our upstream and host, BeeStation, when possible. If your code only changes core files, not NSV-specific mechanics, consider making an upstream pull request. BeeStation requires pre-approval by a maintainer before opening any species-related pull requests.
Code will not be automatically rejected if not ported upstream, but our maintainers may ask you to port it as good practice. If this happens, please leave a comment to tell us whether you will be porting it, or mention the NSV pull request in the BeeStation one so that GitHub links them together. Large PRs of this nature that are ported upstream are more likely to be approved (see the coding standards sections on modular code and bloated code). If the PR is not ported upstream it is up to our staff to decide whether the feature is worth it.
If your upstream PR is rejected or you decide to close it, but still want the PR to be considered on NSV, please also let us know that with a comment for faster response time. We will check the overall status occasionally, but do not closely monitor the progress of upstream PRs.
8. The balance of power[edit | edit source]
While maintainer requests are often good to follow, your PR can still be merged with a change request on it. Repository staff have the ability to dismiss change requests, and leads can bypass normal merge requirements for approval. Leave us a comment or a discord note if you need a second opinion or have questions about whether something is a requirement or just a desirement.
How to Deal with Merge Conflicts[edit | edit source]
Most of the time, Git is pretty smart about merging code files. However, if one PR is merged before yours that edits the same file, your PR will be in a state of conflict and will not be able to be automatically merged via GREEN BUTTON. Because there are more contributors than there are maintainers, most of the time resolving these conflicts falls to the maker of the PR.
An easy way to fix merge conflicts is to make a new branch (you should especially do this if your PR is just a small one):
- Switch to your master branch: Right-click your working folder, go TortoiseGit --> Git Switch/Checkout...
- Look at the Branch-list and select master
- Close the window that pops up (assuming it changed successfully)
- Right-click your working folder, go TortoiseGit --> Git Pull...
- On the top, from the Remote-list, select upstream and from the Remote Branch -list select master.
- Close the window that pops up (assuming it updated successfully)
- Make the same exact changes to the code which you have on your PR
- Commit and MAKE A NEW BRANCH
- Push your new branch to your PR branch, and tick Force: unknown changes
If it's a map file that's conflicted, remember to start the Map Merger before you pull from upstream.
