Development¶

Getting Involved¶

The fachschaftsempfaenger project welcomes help in the following ways:

Making Pull Requests for code, or documentation.

Commenting on open issues and pull requests.

Helping to answer questions in the issue section.

Creating feature requests or adding bug reports in the issue section.

Adapt it to your own needs¶

The following workflow also works fine if you are interested in creating your own infoscreen. Except submitting Pull Requests to our own repository, simply reimplement the submodules and views to your own needs.

Workflow¶

Fork this repository on Github. From here on we assume you successfully forked this repository to https://github.com/yourname/fachschaftsempfaenger.git
Install fachschaftsempfaenger locally in development mode

git clone https://github.com/yourname/fachschaftsempfaenger.git
cd fachschaftsempfaenger
python setup.py develop --user

Create a django project structure on your machine with

django-admin startproject yourproject

Add fachschaftsempfaenger to your INSTALLED_APPS in yourproject/mysite/settings.py:

INSTALLED_APPS = [
    ...,
    'fachschaftsempfaenger'
]

Add code, tests or documentation.

Note

If you are from another student union we recommend to reimplement all submodules to your own needs.

Add and commit your changes.
```
git add -u
git commit -m 'fixes #42 by posing the question in the right way'
```
You can reference relevant issues in commit messages (like #42) to make GitHub link issues and commits together, and with phrase like “fixes #42” you can even close relevant issues automatically.
Push your local changes to your fork:

git push git@github.com:yourname/fachschaftsempfaenger.git

If the changes you made are relevant for our project, feel free to submit a Pull Request at https://github.com/yourname/fachschaftsempfaenger/pulls and click “New pull request” to submit your Pull Request to https://github.com/fsi-tue/fachschaftsempfaenger.

Building documentation¶

The projects documentation is stored in the doc/ folder and is created with sphinx. You can rebuild the documentation by executing

make html

in the documentation folder.