Contributing

We need your help to ensure GenshinMap is information-complete, accessible to players on all platforms, and in multiple languages. If you are native/fluent in a language other than English, and are willing to contribute to translate or to increase the quality of the localized pages, please read on.

How to contribute Routes or Markers Contribution

To contribute create sets of markers or routes to use on the map, complete the following steps:

• Check the Mapping issue label to see what types of features or routes need help.
• Head to GenshinMap.
• Navigate to the Options tab.
• Click the switch labelled "Enable Editor Mode." This will hide the existing markers, and enable the editor controls and the Elements tab.
• Complete a map or route. The Editor mode interface provides a simple means to plot individual markers, as well as directed routes, onto the map.
• Submit the route by clicking the "Submit Route" button at the bottom of the Elements tab.
• Specify a title for your new route and click Confirm. This will redirect you to create a new issue on this GitHub repository, which contains the relevant data needed to create the route.
• If your route includes images for the popups, upload those by dragging to the Issues dialog, or create a ZIP file containing the images and drag that.
• Click "Submit Issue". You may need to create a GitHub account to do this; this is simple, fast, and free.

Once your contribution is submitted, a moderator will review it and potentially add it to the main map.

Use this example for what your final contribution should look like.

How to Localize the Site

Contributing to localization for the general interface has been made easy with the help of a POEditor project.

1. Join the project.
2. Choose the language(s) you want to contribute to. If you are capable of assisting with translating to a language that is not listed, we encourage you to press the "Suggest a new language" button at the bottom.
3. Once you sign up, select your target language. You will see a list of entries on the left side in English. Look for any values on the right side which are blank, untranslated, or poorly translated.
4. Improve the translations by clicking and typing in the boxes. Your work is automatically saved as you complete entries.
5. Pat yourself on the back for being an awesome person who helps out with community projects.

How to Localize Features or Routes, including Popups

A good method to localize features and popups is to create a pull request. This is more complicated than above, especially for non-programmers.

1. Head to the src/data/features folder. Open up the folder for the appropriate region and the appropriate category, then find the file that contains the data for the feature you want to modify.
2. Open the file and click the pencil icon at the top right of the file to start creating an edit proposal.
3. You will find a section of the file, near the top, that looks like this:

  "name": {
    "en": "Geo Hypostasis"
  },

4. Determine the language code of the language you want to add info for. Here is a list. Here I will use French Canadian (fr-cn) as my example.
5. Add the language code and your translation like so. Be careful; spacing doesn't matter, but every entry must be within the curly braces, the quotation marks and colon must be present, and every entry except the last one must be proceeded by a comma:

  "name": {
    "en": "Geo Hypostasis",
    "fr-cn": "Géo-Hypostase"
  },

6. Click the Propose Changes button at the bottom once you are done.
7. IMPORTANT: Click the "Create Pull Request" button to make a request to add your data to the site. If you don't click this button, your changes will get added to your local copy but the team will never see them.
8. Add a descriptive title and a detailed description to your pull request.
9. Click Create Pull Request.
10. Pat yourself on the back for being an awesome person who helps out with community projects.

If you're curious what a 'pull request' actually does, you're creating a copy of the GenshinMap respository on your account, adding the new file to that, then requesting that your changes be pulled into the main repository.

Code, Image, or Style Contribution

This project is in development, and any contributions are greatly appreciated, including but not limited to new features, bug fixes, and improvements to the overall look and feel such as CSS tweaks. Note that this project, and any code or assets you contribute to it, are subject to the copyleft GNU GPL v3 license.