mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-15 07:04:53 +01:00
f65089af86
We're going to commit directly to master from now one. The 'testing' policy predates PyPI releases and Git master was the primary mean of distributing Limnoria back then, but it does not make sense anymore.
34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
# Contributing to Limnoria
|
||
|
||
## Guidelines
|
||
|
||
Follow the [Style Guidelines].
|
||
|
||
When adding a string that will be shown on IRC, always internationalize
|
||
it (wrap it in a call to `_()`).
|
||
When making a trivial change to an internationalized string that does not
|
||
affect the meaning of the string (typo fix, etc.), please update the
|
||
`msgid` entry in localization file. It helps preserve the translation
|
||
without the translator having to review it.
|
||
|
||
Last rule: you shouldn't add a mandatory dependency. Limnoria does not
|
||
come with any (besides Python), so please try to keep all dependencies
|
||
optional.
|
||
|
||
[Style Guidelines]:https://docs.limnoria.net/develop/style.html
|
||
|
||
## Sending patches
|
||
|
||
Don't fear that you spam Limnoria by sending many pull requests. According
|
||
to @ProgVal, it's easier for them to accept pull requests than to
|
||
cherry-pick everything manually.
|
||
|
||
Having at least one test case in any non-trivial pull-request
|
||
is very appreciated.
|
||
|
||
See also [Contributing to Limnoria] at [Limnoria documentation].
|
||
|
||
[Contributing to Limnoria]:https://docs.limnoria.net/contribute/index.html
|
||
|
||
[Limnoria documentation]:https://docs.limnoria.net/
|