Unverified Commit 2253b11c authored by Peter Stanko's avatar Peter Stanko
Browse files

Contributing guide for the portal

parent fede8794
Loading
Loading
Loading
Loading

CONTRIBUTING.adoc

0 → 100644
+7 −0
Original line number Diff line number Diff line
= How to contribute to the Kontr portal

Thank you for considering contributing to the Kontr Portal!

== General Contribution Guide

- Take a look here: link:https://gitlab.fi.muni.cz/grp-kontr2/kontr-documentation/blob/master/contributing/GeneralContributionGuide.adoc[General Contribution Guide]
 No newline at end of file
+6 −4
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ $ pipenv run coverage run -m pytest

=== Deploy postgres

For manual deployment you need to have deployed database - for example postgres.
For manual deployment you need to have deployed database - for example `postgres`.

**Docker instance:**

@@ -104,6 +104,7 @@ Here are some important variables:
- `EMAIL_HOST` - Where is running the mail server
- `EMAIL_PORT` - Port on which the mail server is running
- `EMAIL_DEFAULT_FROM` - From who the emails are
- `PORTAL_DATA_WORKER_DOMAIN` - Domain where default worker will be running (default: `localhost`) This one is mostly for the template

For more take a look at the config files.

@@ -140,15 +141,16 @@ $ flask run -p 8000

== Contributing

Please read `CONTRIBUTION.adoc` for details on our code of conduct,
Please read `CONTRIBUTING.adoc` for details on our code of conduct,
and the process for submitting pull requests to us.

== Authors

* *Barbora Kompišová* - _Initial work_ - https://gitlab.fi.muni.cz/xkompis[xkompis]
* *Peter Stanko*
* *Matej Dujava*
* *Barbora Kompišová* - https://gitlab.fi.muni.cz/xkompis[xkompis]
* *Kristýna Pekarková*
* *Peter Stanko* - https://gitlab.fi.muni.cz/xstanko2[xstanko2]



== Acknowledgments