diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0043532..bfdee12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,13 +5,6 @@ First off, thanks for taking the time to contribute! 👍 The following is a set of guidelines for contributing to this project and its packages, which are hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. -## Code of Conduct - -Use the following conventions: -* Branch: `_c4po_` -* Commit: `feat: ` or `fix: ` -By participating, you are expected to uphold this code. - ## How Can I Contribute? ### Reporting Bugs @@ -35,5 +28,30 @@ Following these guidelines helps maintainers and the community understand your s * **Include screenshots, mock-ups or animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. * **Explain why this enhancement would be useful** +## Code of Conduct + +Use the following conventions: +* Branch: `_c4po_` +* Commit: `feat: ` or `fix: ` +By participating, you are expected to uphold this code. + +## Local development +Security-C4PO and all it's included micorservices can be developed locally. +Execute 'c4po.sh' and all services will run on a dev server. + +#### Testuser Credentials: +* Username: ttt +* Password: Test1234! + +#### Technical Environment Requirements +* Docker / Docker-compose +* OpenJDK 11 +* Node 14.15.1 / npm 6.14.8 +* MongoDB 4.4.6 + +#### Helpfull Tools +* mongoDB Compass +* Postman + ## Additional Notes lorem ipsum.