Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

33 lines (19 loc) · 2.26 KB

Contributing to AssetRipper

First Time Contributors

You can find a list of "good first issues" here. These issues are selected for their relative approachability to first-time contributors.

Pull Requests

I welcome contributions to AssetRipper and have accepted many patches, but if you want your code to be included, please familiarize yourself with the following guidelines:

  • Your submission must be your own work, and able to be released under the GPL license.
  • You will need to make sure your code conforms to the layout and naming conventions used elsewhere in AssetRipper.
  • Try to write "clean code" - avoid long functions and long classes. Try to add a new feature by creating a new class rather than putting loads of extra code inside an existing one.
  • If you are adding a new feature, please consider writing a short tutorial on how to use it.
  • Unless your patch is a small bugfix, I will code review it and give you feedback. You will need to be willing to make the recommended changes before it can be integrated into the main code.
  • Patches should be provided using the Pull Request feature of GitHub.

Localizations

AssetRipper has a built-in localization system, so that people can use it in their native language/dialect if localized text has been contributed.

A web platform has been integrated to make contributing as easy as possible. You can get started here.

You'll need to sign up to start translating to a new localization, or you can suggest translations for an existing localization without an account (but someone with an account will have to manually verify your suggestions). This will send an email to the address you entered. Be sure to check your spam folder, as Gmail sometimes redirects the email there.

Issues

Posting well-written issues is an excellent way to report bugs and share ideas about how AssetRipper can be improved.

Before posting an issue, make sure it hasn't already been addressed in the previously posted issues.

If posting a bug report, please be sure to include your log file. It is in the same folder as the exe file and will be called AssetRipper.log.