diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6a291b2..3b04ae0 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -32,7 +32,16 @@ Submit issues ============= Issues are welcome to both Github_ and the `mailing list`_, at your own -convenience. +convenience. Provide the following information: +- system/distribution (with version) +- offlineimap version (`offlineimap -V`) +- Python version +- server name or domain +- CLI options +- Configuration file (offlineimaprc) +- pythonfile (if any) +- Logs, error +- Steps to reproduce the error Worth the read: `How to fix a bug in open source software`_. diff --git a/README.md b/README.md index a9c9c41..f3e978a 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,16 @@ place on the mailing list.** While not mandatory to send emails, you can [subscribe here](http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project). Bugs, issues and contributions can be requested to both the mailing list or the -[official Github project][offlineimap]. +[official Github project][offlineimap]. Provide the following information: +- system/distribution (with version) +- offlineimap version (`offlineimap -V`) +- Python version +- server name or domain +- CLI options +- Configuration file (offlineimaprc) +- pythonfile (if any) +- Logs, error +- Steps to reproduce the error ## The community