aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Sturmfels <ben@sturm.com.au>2021-09-20 16:58:04 +1000
committerBen Sturmfels <ben@sturm.com.au>2021-09-20 16:58:04 +1000
commit66b19ce1d893fd3166bc2e351f92d8eff6d8dc02 (patch)
tree56b9356286ff20803d622d14e910efebf806df71
parent8ea7d4c58b4e8e6304ca3e16e10692f2b618218d (diff)
downloadmediagoblin-66b19ce1d893fd3166bc2e351f92d8eff6d8dc02.tar.lz
mediagoblin-66b19ce1d893fd3166bc2e351f92d8eff6d8dc02.tar.xz
mediagoblin-66b19ce1d893fd3166bc2e351f92d8eff6d8dc02.zip
Add a stub "contributing" page to documentation.
-rw-r--r--docs/source/devel/contributing.rst29
-rw-r--r--docs/source/index.rst1
2 files changed, 30 insertions, 0 deletions
diff --git a/docs/source/devel/contributing.rst b/docs/source/devel/contributing.rst
new file mode 100644
index 00000000..a61a3fd0
--- /dev/null
+++ b/docs/source/devel/contributing.rst
@@ -0,0 +1,29 @@
+.. MediaGoblin Documentation
+
+ Written in 2011, 2012, 2013, 2020, 2021 by MediaGoblin contributors
+
+ To the extent possible under law, the author(s) have dedicated all
+ copyright and related and neighboring rights to this software to
+ the public domain worldwide. This software is distributed without
+ any warranty.
+
+ You should have received a copy of the CC0 Public Domain
+ Dedication along with this software. If not, see
+ <http://creativecommons.org/publicdomain/zero/1.0/>.
+
+.. _contributing-chapter:
+
+============
+Contributing
+============
+
+This page will describe how to get started contributing to MediaGoblin:
+
+* How to set up a development environment
+* How to run the test suite
+* How to submit code contributions
+
+We eventually hope to migrate the information over from our wiki pages:
+* https://wiki.mediagoblin.org/Main_Page#Technical_project_documentation
+* https://wiki.mediagoblin.org/HackingHowto
+* https://wiki.mediagoblin.org/Git_workflow
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e44a71bf..08d896fd 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -93,6 +93,7 @@ This chapter contains various information for developers.
.. toctree::
:maxdepth: 1
+ devel/contributing
devel/codebase
devel/storage
devel/release