matthias
/
Micromouse
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Note on sending patches

This commit is contained in:
Matthias Portzel 2024-02-23 22:47:03 -05:00
parent 3be31be300
commit fcd21e646d
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README
View File

@ -25,3 +25,15 @@ Download the mms simulator from https://github.com/mackorone/mms/releases.
Pop open a new Mouse in the simulator by clicking the plus next to the "Mouse" selector.
Point it at this directory. Set it up with `/usr/local/bin/zig build` as the build command and `./zig-out/bin/micromouse` as the run command.
## Sending patches
Git is decentralized, which means you don't need an account on Tildegit in order to contribute. Simply clone, make your changes, and commit like normal.
If you have Git configured with your SMTP information, you can use `git send-mail` to email your changes to me.
If you would like to avoid setting up SMTP with Git (understandable), you can instead use `git format-patch`. For example:
```sh
git format-patch HEAD~2 -o outbox
```
This creates patchfiles for the last 2 commits before HEAD. The files that Git places in the "outbox" folder are a standardized plaintext representation of a commit. You can inspect them to ensure they're correct. You can then attach these files to an email in your GUI email application of choice, or other messenger application. (Note: Maintainers of professional projects that claim to accept email patches will not be happy if you do this, but I think it's much easier.)
Once I receive your changes, I'll review them and merge them into the repository. The resulting commits will still list you as the author.