2012-09-18 18:54:32 +02:00
|
|
|
|
# Contributing to Limnoria
|
|
|
|
|
|
2014-05-31 11:58:45 +02:00
|
|
|
|
## 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.
|
|
|
|
|
|
2015-04-27 23:36:54 +02:00
|
|
|
|
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.
|
2014-05-31 11:58:45 +02:00
|
|
|
|
|
2019-01-02 14:32:22 +01:00
|
|
|
|
[Style Guidelines]:https://limnoria.readthedocs.io/en/latest/develop/style.html
|
2014-05-31 11:58:45 +02:00
|
|
|
|
|
|
|
|
|
## Sending patches
|
|
|
|
|
|
2014-05-29 10:36:08 +02:00
|
|
|
|
When you send a pull request, **send it to the testing branch**.
|
2015-05-24 23:29:26 +02:00
|
|
|
|
It will be merged to master when it's considered to be stable enough to be
|
2014-04-10 16:06:02 +02:00
|
|
|
|
supported.
|
2012-09-18 18:54:32 +02:00
|
|
|
|
|
2014-04-10 16:06:02 +02:00
|
|
|
|
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.
|
2012-09-18 18:54:32 +02:00
|
|
|
|
|
2015-05-18 23:30:16 +02:00
|
|
|
|
Having at least one test case in any non-trivial pull-request
|
|
|
|
|
is very appreciated.
|
|
|
|
|
|
2012-09-18 18:54:32 +02:00
|
|
|
|
See also [Contributing to Limnoria] at [Limnoria documentation].
|
|
|
|
|
|
2019-01-02 14:32:22 +01:00
|
|
|
|
[Contributing to Limnoria]:https://limnoria.readthedocs.io/en/latest/contribute/index.html
|
2012-09-18 18:54:32 +02:00
|
|
|
|
|
2019-01-02 14:32:22 +01:00
|
|
|
|
[Limnoria documentation]:https://limnoria.readthedocs.io/
|