.. _section_development:
Development
===========
This section of the documentation is mostly aimed at people who would like to contribute to the development of `cotainr`.
The `cotainr` source code is version controlled using `git `_ and is hosted on GitHub: https://github.com/DeiC-HPC/cotainr
The :ref:`reference documentation ` is hosted on Read the Docs: http://cotainr.readthedocs.io
Contributing to `cotainr`
-------------------------
All contributions, including bug reports, bug fixes, documentation, and new features are welcome.
`cotainr` is free and open source software licensed under the `European Union Public License (EUPL) 1.2 `_. See the `LICENSE `_ file for details about your rights and obligations when using and contributing to `cotainr`.
Feedback & bug reports
~~~~~~~~~~~~~~~~~~~~~~
If you would like to report a bug, request a new features, or provide feedback and/or ideas for improving `cotainr`, please create an issue on the `cotainr` issue tracker: https://github.com/DeiC-HPC/cotainr/issues. A guide for creating an issue on GitHub is available in the `GitHub issue docs `_. Before creating a new issue, please check if somebody else has already opened a similar issue. If so, please contribute your thoughts and experiences to the discussion in that issue instead of opening a new one. If reporting a bug, please provide a `minimal reproducible example `_ of the problem.
Code & documentation contributions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you would like to contribute changes to the `cotainr` codebase or documentation, you are welcome to create a pull request towards the *main* branch on the `cotainr` GitHub repo: https://github.com/DeiC-HPC/cotainr. A guide for creating a pull request is available in the `GitHub pull request docs `_. Please familiarize yourself with the :ref:`style guide `, :ref:`test suite `, and :ref:`reference documentation ` before creating a pull request. Your pull request is much more likely to be accepted and merged into `cotainr` if it follows the style guidelines for `cotainr`, includes proper tests, and is documented. Also, please keep pull request to a single topic.
..
Toc for the rest of the development pages
.. toctree::
:maxdepth: 1
:hidden:
style_guide
test_suite_ci_cd
documentation
technical_motivation
cli_internals
tracing_logging
releasing
systems