|
|
# Getting Started with Trosnoth Development
|
|
|
|
|
|
The purpose of this page is to help new Trosnoth coders begin to understand the inner workings of Trosnoth.
|
|
|
The purpose of this page is to help new Trosnoth coders begin to understand the inner workings of Trosnoth, and the best practices when contributing code.
|
|
|
|
|
|
## Code style
|
|
|
New Trosnoth code should adhere to [PEP 8](https://www.python.org/dev/peps/pep-0008/) with a maximum line length of 99 characters. When naming things, variables and methods should be `lowercase_with_underscores`, classes should be `UpperCamelCase` and constants should be `UPPERCASE_WITH_UNDERSCORES`. Files should generally be `lowercase` with no underscores unless they're needed to avoid ambiguous readings.
|
|
|
|
|
|
## Twisted Reactor
|
|
|
Trosnoth currently uses Twisted to provide its main loop. You don't need to understand everything about Twisted to work on Trosnoth, but there are a few things worth noting:
|
... | ... | |