diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..610468a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# 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: +```asm +; +; Arguments: +; Result: +; Clobbers: +fn_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 +