Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

62 lines (46 loc) · 2.95 KB

Contributing to Warehousing

If you're here, you're awesome! Glad you'd like to help. 😸

The sections below give guidelines for the most common contribution types people make to Warehousing.

Translation updates

If you want to help out with translating the mod, that's great! We just ask that you do so via Crowdin (which supports logging in with GitHub and other existing profiles), and not with a pull request that updates the locale files directly.

Why this way?

Using Crowdin gives us automatic translation updates whenever someone edits a language. Crowdin maintains a branch with the new translations until we merge them in just before releasing a new mod version.

While we do appreciate user-submitted pull requests with new or updated translations, integrating those is much more difficult than translations submitted via Crowdin because of the automated branch-management process. Crowdin updates only the source strings (the English locale file) when syncing to GitHub. It does not pull in new translations—in fact, Crowdin will overwrite any locale changes in its localization branch. Syncing translations in both directions is (as of March 2019) not possible to do automatically, according to responses from Crowdin support.

It is possible to manually import/sync new translations from user-submitted pull requests on GitHub, but for a number of reasons (including the amount of developer time required, potential for errors, and our preferred workflows) we ask that you contribute your translations using Crowdin unless there is an issue preventing you from doing so—in which case, do open a pull request anyway and tell us about the problem, in case it's something we can fix for future translators. Thank you!

Code changes

Tweaks to Warehousing's code are always welcome for consideration. While we cannot promise to merge every pull request, your proposed changes will at least get a looking-over by one or more of the maintainers.

Some of the best code refactoring in the mod's history came from contributors like you—so even if you're not adding a new feature or fixing a bug, feel free to rewrite things if you think they can be done in a clearer way. Maintainers are sometimes too focused on future plans to see improvements that could be made in existing code, after all. 🔍

We just ask that, when opening pull requests, you keep each PR free of unrelated changes. Don't add a new feature when refactoring, for example—make two pull requests instead. Making separate PRs eases code review (we maintainers can look at only one thing at a time), and means that a change we disagree with won't block or delay merging a change we like just because both changes are part of the same PR. (We much prefer using the "Merge pull request" button to cherry-picking commits—it makes life easier when the time comes to write changelogs! 😼)