Skip to content

Commit

Permalink
format doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vuillaut committed Feb 5, 2024
1 parent e4a8dbb commit aea3eb9
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 26 deletions.
20 changes: 9 additions & 11 deletions CONTRIBUTING → CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
Contributing 🤝
---------------

Thank you for your interest in lstmcpipe. We appreciate your willingness to contribute. Here are some guidelines to help you get started.

How to Contribute?
------------------
******************

Ask to admins to be added to the GitHub CTA organization and to the lst-dev group.
This will allow you to create branches and pull requests in the lstmcpipe repository.

Reporting Bugs
--------------
**************

If you find a bug in the code, please open an issue on GitHub. Make sure to include a clear description of the bug and how to reproduce it. If you can, include a code snippet or a small example that reproduces the bug.

Reporting issues in MC productions
----------------------------------
**********************************

If you find an issue in the MC productions, please open an issue on GitHub. Make sure to include a clear description of the issue and findings if you have done any investigation. You may also check the logs in the data directories.

Code contributions
------------------
******************

If you are unsure about the contribution you want to make, please open an issue first to discuss it with the maintainers.

Expand All @@ -33,19 +36,14 @@ Review: Now it's our turn to work! We will look at your Pull Request to ensure i

Merge: Once we have decided that your Pull Request is ready, we will merge it into the project. We thank you for this!

Code of Conduct
When contributing, please respect our code of conduct. We want to keep an open and welcoming community. For more information, please see the CODE_OF_CONDUCT.md file.

Thank You!
Once again, thank you for your contribution. We appreciate your help in improving our project.

Specific Path Configs
---------------------
*********************

If you developed a new path configuration, you may contribute it as it can benefit other analyzers.
Follow the same steps as for code contributions.

Suggesting Enhancements
-----------------------
***********************

If you have an idea for a new feature or an enhancement to the code, please open an issue on GitHub. Make sure to include a clear description of the feature or enhancement you would like to see.
7 changes: 0 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,3 @@ shows the configuration that you are passing to the pipeline.

Note that a complete pipeline still requires quite a lot of resources. Think about other LP-IT cluster users.


Contributing 🤝
---------------

We welcome contributions from the community.

.. include:: CONTRIBUTING
9 changes: 1 addition & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
.. include:: ../README.rst

lstmcpipe API documentation
===========================
.. include:: ../CONTRIBUTING.rst

.. toctree::
:maxdepth: 3
Expand All @@ -20,9 +19,3 @@ lstmcpipe API documentation
api/lstmcpipe


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit aea3eb9

Please sign in to comment.