Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 4.29 KB
Raw

Contributing to Farming_simulator_19_Mods

🎉 Thank you for taking the time to contribute and for seeking out these instructions.

What should I know before I get started?

The goal of these resources

These instructions are designed to help those who would like to contribute to our Mods. By using these sheets, we hope users will:

  • Feel welcome and become active contributors in the open source community, as well as on our mods page.
  • Learn best practices for using Git, GitHub and our GitHub supported projects such this one.
  • Learn how to use the applications within GitHub's ecosystem to build better software.

Types of contributions we love

We're always looking for contributions to help improve these resources. This includes:

  • Translations of existing Mods into new languages.
  • Improving the existing help sheets, also the translations of them.
  • Improving the existing Mods.
  • Suggestions to new Mods.

These are the Existing Game Languages:

en=English - de=German - fr=French - es=Spanish - ru=Russian - pl=Polish - it=Italian - jp=Japanese - cz=Czech - pt=Portuguese - hu=Hungary - nl=Netherlands - cs=Chinese(Simplified) - ct=Chinese(Traditional) - br=Brazilian-Portuguese - tr=Turkish - ro=Romanian - kr=Korean.

How to contribute

Report a bug

Oops, thanks for finding that! If you know how to fix it, please feel free to fork the repository and submit a change via Pull Request.

If you aren't sure how to fix it or just don't have time, we invite you to open a new Issue. Please be sure to provide information so we can recreate the error.

Translate existing resources

At this time, we are only set up to translate the mods into various languages by using Google Translate. (but maybe you can help us change that 😉) If you are planning to contribute a translation, please do the following:

  • Fork this repository
  • Choose your language in the modDesc Folder using the standard abbreviation for the language you are providing.
  • If u can't find your language.
    • Copy the most recent English version of the l10n_en to the file you created.
  • Complete the translation
  • Give it a name describing what mod it belongs to like "FS19_"Template"modDesc_l10n"en".xml
  • Open a pull request against the master branch of this repository.
  • Be sure to @ mention a couple of your friends who are native speakers and ask them to review the translation.
  • Update your translation based on feedback from your friends.

When this process is complete, we will be thankful to merge the completed document.

Contribute something new

Whether you have an idea to make the mods better, or want to contribute a whole new ide for a mod. we ❤️ new ideas! We invite you to open a new Issue to talk about it before you invest too much time. Of course, if you want to experiment first, you can fork this repository and submit your idea via a Pull Request.

Not sure where to start?

If you just want to help out, but don't have a particular change in mind, check out the open issues for projects you can tackle, review an open pull request, or check out the projects.

Building and testing

When you are ready to have your mod/contribution tested, you will want submit it here under a new branch, and create a pull request!

When you are ready to start building a mod with us, you will want to build the repository locally. This can be done by finding our Template Mod Folder!

Thank you for contributing, and if there is anything else don't hesitate to check out our wiki or Contact us