forked from TCShenanigans/symphony_stdlib
26 lines
1003 B
Markdown
26 lines
1003 B
Markdown
# Contributing
|
|
|
|
## Code of Conduct
|
|
Be nice, we are all just doing this to have fun
|
|
|
|
## General rules
|
|
- All text (names, comments, etc.) has to be in English
|
|
- You are responsible for ensuring that you have the rights for us to use the code you contribute to the project
|
|
- follow the guidelines, for code, documentation, etc.
|
|
- all code has to work with the standard symphony ISA
|
|
|
|
## Documenting Functions
|
|
All functions in the standard library should follow the following outline:
|
|
```
|
|
; <description>
|
|
; Arguments: <which register contains what argument>
|
|
; Result: <what is the result, and where is it stored>
|
|
; Clobbers: <list of registers that are clobbered>
|
|
<label>: <;SHOULD BE INLINED>
|
|
<CODE>
|
|
|
|
```
|
|
|
|
Functions should be in the appropriate asm file, if you are unsure where functionality fits make a seperate file and ask in the pull request
|
|
Functions that are provided for convenience/reference but should be inlined in production code should be marked with `;SHOULD BE INLINED` after their label
|