Vous avez reçu un message "Your GitLab account has been locked ..." ? Pas d'inquiétude : lisez cet article https://docs.gricad-pages.univ-grenoble-alpes.fr/help/unlock/

Commit 2a762c1a authored by Millian Poquet's avatar Millian Poquet
Browse files

[doc] sphinx: more TODOs

parent d703b9a0
Pipeline #15399 passed with stages
in 20 minutes and 45 seconds
.. _changelog:
Changelog
=========
.. todo::
Update Markdown changelog and transform it into RST
.. _ci:
Continuous Integration
======================
.. todo::
Document Batsim continuous integration.
- Where is the CI?
- How to look at the build logs?
- How to reproduce a build on your machine?
- How does it work?
- How to update the CI?
.. _contributing:
Contributing
============
.. todo::
Write how to contribute to Batsim.
- Write a rationale about which objectives are currently important to us (maintainability, as we lack dev manpower) and which are not of utmost importance. State that we try to avoid the presence of very specific code in Batsim itself.
- Write how to contribute to the different parts (doc, code, tests, misc.), and where.
- Write some git expected usage.
- Write coding style.
- Write a checklist to guide PRs (we can configure github/gitlab to show such a list when creating a new PR).
......@@ -35,6 +35,7 @@ Batsim
Protocol <protocol.rst>
Using Redis <redis.rst>
Using the I/O model <IO.rst>
Changelog <changelog.rst>
.. toctree::
:maxdepth: 1
......@@ -55,4 +56,6 @@ Batsim
:maxdepth: 1
:caption: Developer Manual
Contributing <contributing.rst>
Continuous Integration <ci.rst>
TODO list <todo.rst>
Markdown is supported
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