- Be polite, respect others
- Be patient, remember that this is a hobby project
- Do at least some basic research before asking for help
- Make sure to read the documentation. It covers most basic questions and gives guidance on how to set up and use the converter and JSON files
- Make sure to check if similar issues are already opened
- Make sure that your problem is indeed related to this project and does not originate from or caused by the original JMdict/JMnedict XML files or any third-party software
If you need help with setting up Gradle and/or Java/JVM/OpenJDK, please refer to the official docs:
- Gradle User Manual - remember that this project comes with a bundled Gradle wrapper, so you don't have to install Gradle yourself
- Azul OpenJDK installation: Mac OS, Windows, Debian-based Linux, RPM-based Linux, etc.
-
Write a descriptive title. Think of a title you would like to see when searching for a solution to your problem.
- Bad example: "Missing data" - Which data? Where?
- Better: "Missing attribute 'attr_name'" - Where is this attribute supposed to be?
- Good example: "Missing attribute 'attr_name' on gloss elements in JMdict"
-
Provide enough details to understand the problem:
- Describe the result you expected and what you actually got
- Include a sample of a dictionary, if necessary. For example, comparing the original XML file entry with its JSON counterpart to illustrate the difference.
- Provide a command line output if you get an error. Preferably as a text, not a screenshot
-
If you can suggest a possible solution, please feel free to do so
-
Write a descriptive title (see above)
-
Describe your problem, use case, and/or motivation to ask for this feature. Sometimes, there might already exist a solution which you haven't thought of. Understanding what you're trying to achieve can help find a solution which would benefit others, e.g. by being more generic or approaching the problem from a different perspective.
-
If you have some specific technical requirements, please describe them.