Contributing - Yhzan95/GettingUpModdingTool GitHub Wiki

Contributing

Bug reports, documentation improvements and pull requests are welcome.

Before contributing

Before making a change:

  1. Check the existing documentation and issues.
  2. Make sure the change is not already being worked on.
  3. Keep changes focused on a specific feature or problem.

Good bug reports

Include:

  • What you did
  • What you expected
  • What actually happened
  • Steps to reproduce the issue
  • The affected file's path inside the game folder
  • Tool version
  • crash.log if the application crashed
  • Screenshot when useful

Do not upload original copyrighted game files or game assets.

Code contributions

Before submitting a change:

  1. Build the project.
  2. Test the affected workflow.
  3. Check that existing asset browsing still works.
  4. Test relevant export paths when applicable.
  5. Check localization if UI text changed.
  6. Make sure the application still starts correctly.

Keep changes focused and avoid unrelated modifications.

Documentation contributions

Documentation improvements are welcome. When documenting a feature:

  • Explain the feature from a user's perspective.
  • Use screenshots when they improve clarity.
  • Keep terminology consistent with the application.
  • Link to related wiki pages when appropriate.
  • Clearly identify experimental features and limitations.

Reverse-engineering contributions

For game-format discoveries, clearly separate:

  • Confirmed findings
  • Observations
  • Hypotheses
  • Unknown fields

Provide enough context for someone else to reproduce the finding.

When documenting an unknown format field, include information such as:

  • File type
  • File path
  • Offset or location when known
  • Observed values
  • Test results
  • Confidence level

Do not present an unconfirmed hypothesis as a documented fact.

Pull requests

When submitting a pull request:

  • Describe what was changed.
  • Explain why the change is needed.
  • Mention relevant issues when applicable.
  • Include testing information.
  • Include screenshots for UI changes when useful.

Keep pull requests focused on a specific feature, fix or improvement.

Localization contributions

When changing UI text:

  1. Use the existing localization system.
  2. Update the relevant translation entries.
  3. Preserve dynamic placeholders.
  4. Check the affected language in the application.
  5. Update other supported languages when possible.

See Localization.

Related pages