How to Contribute

Here is a little Guide for everyone who want to fork the Projekt and help making it better

To run the Wiki node.js is needed install it before doing anything else with this

1. Fork the Repo

Create a fork of the Repo to your github account

2. Download and Open

Download the Repo and open it in your IDE of choice

3. Installing dependencies

To install everything needed open the Terminal inside your IDE move to the root of the AugustusWiki folder and run “npm install”

4. Self testing

To test changes made type npm run dev which will host a copy of the Wiki which updates in realtime and to make sure everything is working

5. Commit changes

After you are done changing things you can commit those to your fork of the wiki and then PR them to the staging repo of AugustusWiki which will then be reviewd and in the best case merged

⚠ Information

Do not update any node.js packages. Updates to those packages will be done by Maintainers of the Repo. IF you PR changes that include modification to either package-lock.json or package.json your PR will be denied