Apple-2-SW
/
AppleIIAsm-Collection
mirror of https://github.com/nathanriggs/AppleIIAsm-Collection.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Create CONTRIBUTING.md

This commit is contained in:
Nathan D Riggs 2019-01-06 21:37:07 -05:00 committed by GitHub
parent 5a028d19f4
commit e0f7cfc28b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,13 @@
# How to Contribute
Well it hasn't happened yet, but if you feel like you'd like to contribute to this stange little project--Awesome! Here are a few things to keep in mind.
## Code Editing Process and Style
* You should always edit code in Merlin 8 Pro, then export it via CiderPress in order to preserve proper formatting. Merlin 8 Pro does not play nicely with text formatted by modern editors.
* Please make sure to keep the disks in the bin folder on track with the source code extractions.
* Comment as much as possible, but stay within reason. Be sure the comments are informative, and not just wasting precious bytes.
* Currently, every subroutine has a minified version as well as a standalone commented version on the disk, in addition to that subroutine's home library. This means that any time a routine is altered, you should alter it in the library first. Then, when it is changed to your satifaction, delete all but the subroutine and save that as the standalone, being careful not to write over the library itself! Then you can delete all the comments and create the .min file.
* I plan on writing a program to automate this process in the near future, and it will likely involve storing all minified code on separate disks.
That's it for now! If this project ever gets complicated enough for more than a handful of contributors, we may have to be clear on a few other details. But right now, all contributions are welcome!