24 lines
740 B
Markdown
24 lines
740 B
Markdown
# Contributing
|
|
First off, we thank you for taking the time to contribute to the crumpet engine project.
|
|
|
|
When contributing or submitting pull requests follow these guidelines or your contribution will not be taken seriously.
|
|
|
|
If you want to contribute but don't know what to do, see TODO.txt for a list of tasks that need to be complete, but make sure when you complete one you mark it as such, do not remove it from the list.
|
|
|
|
## Make sure your code is
|
|
- Functional
|
|
- Maintainable and Scalable
|
|
- Readable
|
|
|
|
## Linting
|
|
- Tabs - 4 spaces
|
|
- Same line bracing
|
|
- Honestly just look around the code base and imitate the style
|
|
- Keep code well commented
|
|
|
|
## Guidelines
|
|
- See CODE_OF_CONDUCT.md
|
|
|
|
## Pull requests we reject
|
|
Anything from b_boy_ww
|