Commit ff7cfd5e authored by hynek's avatar hynek 🤤
Browse files

docs(contributing): describe the process of contributing

this still is incomplete
parent caa8155e
see https://discuss-data.pages.gwdg.de/discuss-data/docs/contribution.html
\ No newline at end of file
============================
Contributing to Discuss Data
============================
As an open source project, Discuss Data welcomes contributions of many forms.
Examples of contributions include:
* Code patches
* Documentation improvements
* `Bug reports`_ and patch reviews
* Feature requests
* Merge requests
Discuss Data uses pre-commit hooks to ensure the compliance of contributions with our coding standards.
::
pre-commit install
Commits have to follow the conventional commit standard. This repo is configured
commitizen friendly so that you can use it to comply with our commit format.
We welcome and are likely to accept merge requests that follow the aforesaid.
.. _`Bug reports`: https://gitlab.gwdg.de/discuss-data/discuss-data/-/issues
How to fix a Bug
================
To contribute by fixing a Bug, follow these steps:
#. Write a test that
- reproduces the wanted behaviour and
- fails because of the bug.
#. Write a fix that
- produces the wanted behaviour and
- lets the previosly written test pass.
...@@ -24,5 +24,5 @@ Create Pages Skeletons ...@@ -24,5 +24,5 @@ Create Pages Skeletons
To create empty skeleton pages for the landing page and some documentation pages call the initial_data django runscript: To create empty skeleton pages for the landing page and some documentation pages call the initial_data django runscript:
`docker-compose -f local.yml run --rm django python manage.py runscript initial_data` `docker-compose run --rm django python manage.py runscript initial_data`
.. include:: ../CONTRIBUTING.rst
\ No newline at end of file
============================
Contributing to Discuss Data
============================
As an open source project, Discuss Data welcomes contributions of many forms.
Examples of contributions include:
* Code patches
* Documentation improvements
* Bug reports and patch reviews
...@@ -12,7 +12,7 @@ Table of Contents: ...@@ -12,7 +12,7 @@ Table of Contents:
:maxdepth: 2 :maxdepth: 2
requirements requirements
contribution contributing
cms cms
......
Supports Markdown
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