Skip to content
Snippets Groups Projects
Commit 91fe6d72 authored by Christoph Groth's avatar Christoph Groth
Browse files

mention kwant-devel

parent 02ee2855
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 56 additions and 18 deletions
content/community.txt
+ 56
− 18
View file @ 91fe6d72
Getting help, contributing and reporting problems Getting help, contributing and reporting problems
================================================= =================================================
Mailing list General mailing list
------------ --------------------
The mailing list is the main public communication platform for anything related The `kwant-discuss
to Kwant: questions, bug reports, discussions, and announcements. You can use <https://mailman-mail5.webfaction.com/listinfo/kwant-discuss>`_ mailing list is
it in various ways: the main public communication platform for anything related to Kwant: questions,
bug reports, discussions, and announcements. You can use it in various ways:
- .. raw:: html - .. raw:: html
<p><form id="searchgmane" method="get" action="http://search.gmane.org/"> <p><form id="searchgmane" method="get" action="http://search.gmane.org/">
<input type="text" name="query" size=25 value="Your query" onblur="if (this.value == '') {this.value='Your query'}" onfocus="if (this.value == 'Your query') {this.value=''}" /> <input type="text" name="query" size=25 value="Your query" onblur="if (this.value == '') {this.value='Your query'}" onfocus="if (this.value == 'Your query') {this.value=''}" />
<input type="hidden" name="group" value="gmane.comp.science.kwant.user" /> <input type="hidden" name="group" value="gmane.comp.science.kwant.user" />
<input type="submit" value="Search the mailing list" /> <input type="submit" value="Search kwant-discuss" />
</form></p> </form></p>
- .. raw:: html - .. raw:: html
<form method=post action="https://mailman-mail5.webfaction.com/subscribe/kwant-discuss"> <form method=post action="https://mailman-mail5.webfaction.com/subscribe/kwant-discuss">
<input type="text" name="email" size=25 value="Your email address" onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" /> <input type="text" name="email" size=25 value="Your email address" onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<input type="submit" name="email-button" value="Subscribe to the mailing list" /> <input type="submit" name="email-button" value="Subscribe to kwant-discuss" />
</form> </form>
… and receive new messages with your regular email. (Use the `kwant-discuss options page <https://mailman-mail5.webfaction.com/options/kwant-discuss>`_ to unsubscribe.) … and receive new messages with your regular email. (Use the `kwant-discuss options page <https://mailman-mail5.webfaction.com/options/kwant-discuss>`_ to unsubscribe.)
...@@ -35,8 +36,45 @@ it in various ways: ...@@ -35,8 +36,45 @@ it in various ways:
so you should ask to be CCed.) so you should ask to be CCed.)
Announcements of new releases (low-volume) Development list
------------------------------------------ ----------------
Those who are interested (or would like to participate) in the further
development of Kwant are invited to subscribe to the `kwant-devel
<https://mailman-mail5.webfaction.com/listinfo/kwant-devel>`_ mailing list.
This is the place for technical discussions about changes to Kwant.
Please do not send bug reports to this list but rather to kwant-discuss.
Kwant-devel works in the same way as kwant-discuss:
- .. raw:: html
<p><form id="searchgmane" method="get" action="http://search.gmane.org/">
<input type="text" name="query" size=25 value="Your query" onblur="if (this.value == '') {this.value='Your query'}" onfocus="if (this.value == 'Your query') {this.value=''}" />
<input type="hidden" name="group" value="gmane.comp.science.kwant.devel" />
<input type="submit" value="Search kwant-devel" />
</form></p>
- .. raw:: html
<form method=post action="https://mailman-mail5.webfaction.com/subscribe/kwant-devel">
<input type="text" name="email" size=25 value="Your email address" onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<input type="submit" name="email-button" value="Subscribe to kwant-devel" />
</form>
(Use the `kwant-devel options page <https://mailman-mail5.webfaction.com/options/kwant-devel>`_ to unsubscribe.)
- There exist web interfaces: `kwant-devel on Gmane <http://dir.gmane.org/gmane.comp.science.kwant.devel>`_ and
`kwant-devel on Mail-archive <https://www.mail-archive.com/kwant-devel@kwant-project.org/>`_.
Both provide RSS feeds, Gmane also allows posting through the web interface.
- Message can be sent directly to kwant-devel@kwant-project.org. (If you are not
subscribed, it is not guaranteed that any followups will reach you by email,
so you should ask to be CCed.)
Announcements (low-volume)
--------------------------
This read-only list is reserved for important announcements like new releases of This read-only list is reserved for important announcements like new releases of
Kwant. Only a few messages will be sent per year. These announcements will be also posted on the main mailing list, so there is no need to subscribe to both lists. We recommend every user of Kwant to subscribe at least to this list in order to stay informed about new developments. Kwant. Only a few messages will be sent per year. These announcements will be also posted on the main mailing list, so there is no need to subscribe to both lists. We recommend every user of Kwant to subscribe at least to this list in order to stay informed about new developments.
...@@ -57,12 +95,13 @@ Reporting bugs ...@@ -57,12 +95,13 @@ Reporting bugs
-------------- --------------
If you encounter a problem with Kwant, first try to reproduce it with as simple If you encounter a problem with Kwant, first try to reproduce it with as simple
a system as possible. Double-check with the documentation that what you a system as possible. Double-check with the documentation that what you observe
observe is actually a bug in Kwant. If you think it is, please check whether is actually a bug in Kwant. If you think it is, please check whether the problem
the problem is already known by searching the mailing list. is already known by searching the general mailing list. (You may use the search
box at the top of this page.)
If the problem is not known yet, please send a bug report to the mailing list. If the problem is not known yet, please send a bug report to
A report should contain: kwant-discuss@kwant-project.org. A report should contain:
* The versions of software you are using (Kwant, Python, operating system, etc.) * The versions of software you are using (Kwant, Python, operating system, etc.)
...@@ -82,8 +121,7 @@ leaving room for growth, and plan to keep extending it. ...@@ -82,8 +121,7 @@ leaving room for growth, and plan to keep extending it.
External contributions to Kwant are highly welcome. You can help to advance External contributions to Kwant are highly welcome. You can help to advance
the project not only by writing code, but also by reporting bugs, and the project not only by writing code, but also by reporting bugs, and
fixing/improving the documentation. A `mailing list fixing/improving the documentation.
</community.html>`_ is available for discussions.
If you have some code that works well with Kwant, or extends it in some useful If you have some code that works well with Kwant, or extends it in some useful
way, please consider sharing it. Any external contribution will be clearly way, please consider sharing it. Any external contribution will be clearly
...@@ -91,8 +129,8 @@ marked as such, and relevant papers will be added to the list of `suggested ...@@ -91,8 +129,8 @@ marked as such, and relevant papers will be added to the list of `suggested
acknowledgements </citing.html>`_. The complete development history is also acknowledgements </citing.html>`_. The complete development history is also
made available through a `web interface <http://git.kwant-project.org/kwant>`_. made available through a `web interface <http://git.kwant-project.org/kwant>`_.
If you plan to contribute, it is best to coordinate with us in advance either If you plan to contribute, it is best to coordinate with us in advance either
through the mailing list, or directly at authors@kwant-project.org for matters through the general mailing list kwant-discuss@kwant-project.org, or directly at
that you prefer to not discuss publicly. authors@kwant-project.org for matters that you prefer to not discuss publicly.
How to contribute How to contribute
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment