Skip to content

Commit

Permalink
doc: Rewrite Contributing and Community pages
Browse files Browse the repository at this point in the history
Split the Contributing chapter to create a Community chapter.
Document the Summer School and how to access the teaching material.
Update the Contributing page of the project community standards.
  • Loading branch information
jngrad committed Apr 19, 2022
1 parent 061c11a commit 2473264
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 55 deletions.
42 changes: 22 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,69 +3,71 @@

Thank you for your interest in contributing to ESPResSo! There
are many ways to contribute and we appreciate all of them. This
document is a quite lengthy, so here is a list of links to the
document is quite lengthy, so here is a list of links to the
major sections:

* [New Features](#new-features)
* [Bug Reports](#bug-reports)
* [Pull Requests](#pull-requests)
* [Writing Documentation](#writing-documentation)
* [Helpful Links and Information](#helpful-links-and-information)

If you have questions, please make a post on [the developers
If you have questions, please make a post on [the users
mailing list][mailing-list].

[mailing-list]: https://lists.nongnu.org/mailman/listinfo/espressomd-devel
[mailing-list]: https://lists.nongnu.org/mailman/listinfo/espressomd-users

## New Features
[new-features]: #new-features

If you plan to create a new feature for ESPResSo, it is
*absolutely essential* that you first post your plan on [the
developers mailing list][mailing-list]. This way we can give you
useful tips how to go about a successful integration and can
*absolutely essential* that you first post your plan on the
[users mailing list][mailing-list]. This way we can give you
useful tips on how to go about a successful integration and can
point out possibly reusable code. Maybe your feature even exists
already and you just didn't notice it, so we want to save you the
effort.

## Bug Reports
[bug-reports]: #bug-reports

We cannot fix bugs we don't know about, so please report
liberally. If you are unsure whether something is a bug or not,
feel free to file a bug anyway.
We cannot fix bugs we don't know about, so please report liberally.
If you are unsure whether something is a bug or not, feel free to
ask on the [users mailing list][mailing-list] or on the
[discussion forum](https://github.com/espressomd/espresso/discussions).

To fix your problem quickly it is essential that we have an easy
way to reproduce your bug. Therefore you should include in your
report the *desired behavior*, a *specific problem or error* and
*the shortest script necessary* to reproduce it. Ideally you
also include the affected version and list of features activated
in `myconfig.hpp`.
*the shortest script necessary* to reproduce it. We have handy
step-by-step instructions in the wiki page [Filing bug reports
](https://github.com/espressomd/espresso/wiki/Filing-bug-reports).

## Pull Requests
[pull-requests]: #pull-requests

Pull requests are the primary mechanism we use to change
ESPResSo. GitHub itself has some [great documentation][pull-requests]
Pull requests are the primary mechanism we use to change ESPResSo.
GitHub itself has some [great documentation][gh-pull-requests]
on using the Pull Request feature. We use the "fork and pull"
model [described here][development-models], where contributors
model [described here][gh-development-models], where contributors
push changes to their personal fork and create pull requests to
bring those changes into the source repository.

[pull-requests]: https://help.github.com/articles/about-pull-requests/
[development-models]: https://help.github.com/articles/about-collaborative-development-models/
[gh-pull-requests]: https://help.github.com/articles/about-pull-requests/
[gh-development-models]: https://help.github.com/articles/about-collaborative-development-models/

Please make pull requests against the `python` branch.

We have a continuous integration system for automated testing,
We have a continuous integration system for [automated testing](
https://github.com/espressomd/espresso/wiki/Code-review#automated-code-review),
which runs on all pull requests to see whether new additions play
nicely with the existing code. Because it takes a long time for
all the tests to be completed, you might want to run `make check`
with the settings from `maintainer/configs/maxset.hpp` locally
first.

All pull requests are reviewed by one or more of the ESPResSo
core team members.
core team members, as explained in the wiki page [Code review
](https://github.com/espressomd/espresso/wiki/Code-review#Human_code_review).

## Writing Documentation
[writing-documentation]: #writing-documentation
Expand Down
1 change: 1 addition & 0 deletions doc/sphinx/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ if(SPHINX_FOUND)
"${CMAKE_CURRENT_SOURCE_DIR}/advanced_methods.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/analysis.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/appendix.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/community.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/constraints.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/contributing.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/ek.rst"
Expand Down
51 changes: 51 additions & 0 deletions doc/sphinx/community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
.. _Community:

Community
=========

.. _Community support:

Community support
-----------------

If you have any questions concerning |es| which you cannot resolve by
yourself, you may search for an answer on:

- `GitHub issue tracker <https://github.com/espressomd/espresso/issues?q=>`__
- `GitHub discussions <https://github.com/espressomd/espresso/discussions>`__
- `espressomd-users mailing list archive <https://lists.nongnu.org/archive/html/espressomd-users/>`__
- `Installation FAQ <https://github.com/espressomd/espresso/wiki/Installation-FAQ>`__

If you still didn't find a solution, you may consider either opening a new
issue or discussion on GitHub, or sending an email on the mailing list.
Instructions on how to register to the mailing lists and post messages can be
found in `Mailing Lists
<https://espressomd.org/wordpress/community-and-support/mailing-lists/>`__.
It is recommended to use these communication channels rather than to contact
individual developers, for several reasons:

- All users get your message and you have a higher
probability that it is answered soon.
- Your question and the answers are archived and the archives can be
searched by others.
- The answer may be useful also to other users.
- There may not be a unique answer to your problem and it may be useful
to get suggestions from different people.

Please remember that this is a community mailing list and a community GitHub
forum. It is other users and developers who are answering your questions.
They do it in their free time and are not paid for doing it.

.. _Summer Schools:

Summer Schools
--------------

Every year in October, a 5-day workshop is organized at University of Stuttgart, Germany.
Registration is free of charge and is managed by `CECAM <https://www.cecam.org/>`__.
Past events are archived on the |es| official website, under `Summer Schools
<https://espressomd.org/wordpress/community-and-support/espresso-summer-school/>`__.
The teaching material can be found in the online documentation, section
`Tutorials <https://espressomd.github.io/tutorials.html>`__. The lectures
can be found on the `ESPResSo Simulation Package
<https://www.youtube.com/channel/UC6yzqhq2KrT-aDhPjcL-VNw>`__ YouTube channel.
33 changes: 0 additions & 33 deletions doc/sphinx/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,39 +17,6 @@ The official website at https://espressomd.org provides additional information:
- Archives of both developers' and users' mailing lists
- Registering to mailing lists

.. _Community support:

Community support
-----------------

If you have any questions concerning |es| which you cannot resolve by
yourself, you may search for an answer on:

- `GitHub issue tracker <https://github.com/espressomd/espresso/issues?q=>`__
- `GitHub discussions <https://github.com/espressomd/espresso/discussions>`__
- `espressomd-users mailing list archive <https://lists.nongnu.org/archive/html/espressomd-users/>`__
- `Installation FAQ <https://github.com/espressomd/espresso/wiki/Installation-FAQ>`__

If you still didn't find a solution, you may consider either opening a new issue
on GitHub or sending an email on the mailing list. Instructions on how to
register to the mailing lists and post messages can be found in `Mailing Lists
<https://espressomd.org/wordpress/community-and-support/mailing-lists/>`__.

For several reasons it is recommended to send all questions to the issue
tracker or mailing list rather than to contact individual developers:

- All registered users get your message and you have a higher
probability that it is answered soon.
- Your question and the answers are archived and the archives can be
searched by others.
- The answer may be useful also to other registered users.
- There may not be a unique answer to your problem and it may be useful
to get suggestions from different people.

Please remember that this is a community mailing list and a community issue
tracker. It is other users and developers who are answering your questions.
They do it in their free time and are not paid for doing it.

.. _Contributing your own code:

Contributing your own code
Expand Down
8 changes: 6 additions & 2 deletions doc/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ User's Guide
advanced_methods.rst
reaction_methods.rst
under_the_hood.rst
community.rst
contributing.rst
appendix.rst
bibliography.rst
Expand All @@ -39,8 +40,11 @@ User's Guide
Online resources
----------------

* `Repository <https://github.com/espressomd/espresso>`_
* `Wiki <https://github.com/espressomd/espresso/wiki>`_
* `GitHub repository <https://github.com/espressomd/espresso>`_
* `GitHub discussions <https://github.com/espressomd/espresso/discussions>`_
* `ESPResSo wiki <https://github.com/espressomd/espresso/wiki>`_
* `Online documentation <https://espressomd.github.io/>`_
* `Official website <https://espressomd.org/wordpress/>`_

Python modules
--------------
Expand Down

0 comments on commit 2473264

Please sign in to comment.