Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

77 lines (49 loc) · 3.07 KB
Raw

Contributing to Recaf

The following is a series of guidelines for contributing to Recaf. They're not "rules" per say, rather they're more like goals to strive towards. Regardless of how closely you adhere to the following guidelines I really appreciate you taking the time to contribute, it means a lot 👍

Table of Contents

TLDR?

  • Follow the code style.
  • Document and comment your code.
  • Make sure the tests pass after making changes.
  • Translations and feature ideas are appreciated too.

Questions?

You can DM invokecoley on discord, or join the Recaf discord.

What if I am not a programmer?

There is plenty to contribute that isn't based in code.

For example, you can contribute ideas, add translations, or write documentation:

What should I know before getting started?

It depends on what changes you are making. For instance, changing the user-interface requires very minimal or no reverse-engineering prior knowledge. If you do need JVM reversal knowledge to work on a feature you can check the primer guide which points to several good resources and outlines key details.

Is there a to-do list?

Unfortunately the to-do list is scattered around a a few places. We're working on eventually consolidating everything into one place.

Reporting Bugs

When creating an issue select the Bug report button. This will provide a template that you can fill in the details for your bug. Please include as much information as possible. This can include:

  • Clear and descriptive title
  • Log files
  • Steps to reproduce the bug
  • An explanation of what you *expected* to happen
  • The file being analyzed (Do not share anything you do not own the rights to)

Suggesting Features

When creating an issue select the Feature request button. This will provide a template that you can fill in the details for your feature idea. Be as descriptive as possible with your idea.

Note: Not all ideas may be within Recaf's scope. In these cases the feature should be implemented as a script or plugin.

Coding Guidelines

Style: IDE code formatting rules can be found in the /setup directory.

Commits: Try and keep commits small and focused on one thing at a time.

Pull Requests

When creating a pull request please consider the following when filling in the template:

  • Clear and descriptive title
  • A clear description of what changes are included in the pull

Github's PR system will validate that your changes compile and pass the unit tests as well.