diff options
| author | Kenix3 <kenixwhisperwind@gmail.com> | 2021-09-02 10:31:28 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-02 10:31:28 -0400 |
| commit | c94fd6ccbcab53077a96bdce573ff5ec9d39e88f (patch) | |
| tree | 89e9b18bc70b9dcf4e37f1c8ddcc5c31c25b6ee6 | |
| parent | e6b73951c60072f6a788be77d23210c1d16c05e0 (diff) | |
Updates README to add an FAQ, and also updates CONTRIBUTING to be explicit on the reservation workflow process. (#245)
| -rw-r--r-- | CONTRIBUTING.md | 7 | ||||
| -rw-r--r-- | README.md | 5 |
2 files changed, 10 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index add3307a0..2ae00f424 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,6 +53,10 @@ You should [join the Discord](https://discord.zelda64.dev/) to say hello and get We track who is working on what on the [Trello board](https://trello.com/b/ruxw9n6m/majoras-mask-decompilation). After joining the Discord, ask to be added to the Trello board so you can claim your code file and avoid duplicate work. You may need to add a card if a card for your file does not currently exist. +The work flow is: Reserve a file, decompile it, submit a PR, and then repeat while addressing review comments. The expectation is that one reservation goes to one file which ends up in a one file PR. + +Please note that unless it is communicated beforehand you will be expected to fully complete the file if you reserve it on Trello. Exceptions are always easy to approve if it's communicated to the team. Real life circumstances can prevent someone from finishing. In these cases they should link their repo/branch in the trello and unreserve immediately. Communicate any issues with your reservations as early as possible. + Style Guide & Conventions ------------------------- @@ -119,8 +123,7 @@ Documenting is more than just adding comments. Documenting also includes: - Using (or adding) constants, enums, and macros when possible - Explaining sections of code that are not straightforward -Overlays are not required to be documented at this time, but `code/` and `boot/` should be documented as much as possible. -When an overlay documentation has been started, it will be required to be completed. +Overlays are not required to be documented at this time, but `code/` and `boot/` should be documented. When documentation on a file has been started it should be as complete as possible. For right now, object segment symbols should not be documented/renamed. These will be given names when object reconstruction is ready. @@ -133,3 +133,8 @@ Anyone who wishes to contribute to the OOT or MM projects **must not have access Most discussions happen on our [Discord Server](https://discord.zelda64.dev), where you are welcome to ask if you need help getting started, or if you have any questions regarding this project and other decompilation projects. For more information on getting started, see our [Contributing Guide](CONTRIBUTING.md) and our [Code Review Guidelines](REVIEWING.md) to see what code quality guidelines we follow. + +## FAQ + +### Q: Why does MM use transient assembly? +A: It is the view of the MM project leads that transient asm is safer than storing the disassembly in the repo. We feel like the C code is more transformative than a straight disassembly.
\ No newline at end of file |