Thanks for your interest in improving lucia. In the attempt to maintain code clarity and format, each pull request is evaluated before being merged. To make sure your changes are able to be used and valued by everyone, we ask that you read and abide by the following. Pull requests/issues that don't adhere to these specifications will receive a lower priority overall.
This repository is strictly for development. questions are best answered by our audiogames.net topic
All contributions start out as issues. File one right here
If there's enough community interest, let us know you've taken it on and feel free to begin writing code.
All contributions must
- Use pep8, with diversions laid out here
- Use tabs over spaces
- Cammel case for classes, names separated by underscores for functions
- Globals are to be written in all capital letters, with underscores as separation
- Sphinx style docstrings
- Comment when a procedure isn't necessarily obvious (discression here). Your future self and other contributors will thank you later
Make a pull request, siting the specific issue you intend to address. All Pull Requests that don't have associated issues will subsequently be ignored.
Lucia is currently untested at large. Thus, we expect many bugs to crop up. In order to help us help you, try and provide as much information as possible so we can get to the bottom of the issue. Along with including your error, the following is a list of questions that should be addressed in each issue labeled as a bugfix. Exclude as applicable.
- What were you trying to do?
- what happened?
- What did you expect to happen?
- Are you using the most up-to-date version of Lucia?
- Under what platform do you receive the issue?
- What version of said platform are you running?
- Do you have any idea what may be causing the problem and/or how it might be fixed?
- Anything else you think may assist us in addressing/solving the problem