Skip to content
Snippets Groups Projects
Verified Commit 8a5b9897 authored by Antoine R. Dumont's avatar Antoine R. Dumont
Browse files

Introduce contributors faq

Related to T3119
parent ac0799f0
No related branches found
No related tags found
No related merge requests found
.. _faq:
Frequently Asked Questions
==========================
How can I compute my SWHID?
---------------------------
We propose a cli to ease such computation ``swh identify``...
how should I document the code I contribute to SWH?
---------------------------------------------------
Any new feature should include documentation in the form of comments and/or docstrings.
Ideally, they should also be documented in plain English in the repository's `docs/`
folder if relevant to a single package, or in the main `swh-docs` repository if it is a
transversal feature.
What are the minimum system requirements (hardware/software) to run SWH locally?
--------------------------------------------------------------------------------
See the `developer setup documentation <https://docs.softwareheritage.org/devel/developer-setup.html#developer-setup>`__
.. _swh-docs:
Software Heritage - Development Documentation
=============================================
Getting started
---------------
......@@ -46,6 +44,8 @@ Tutorials
* :doc:`/tutorials/issue-debugging-monitoring`
* :ref:`Listing the content of your favorite forge <lister-tutorial>`
and :ref:`running a lister in Docker <run-lister-tutorial>`
* :ref:`faq`
Roadmap
-------
......@@ -200,6 +200,7 @@ Indices and tables
architecture/index
contributing/index
tutorials/index
faq
roadmap/roadmap-2021.rst
infrastructure/index
swh.auth <swh-auth/index>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment