Wow you landed on the contribution page how awesome you must be to help out and add value to his project! We thank you very much for this and we really appricate your help. We will reward contributors with recongnision on the contributors list of SKF and for people who add new feutures or fix / report security issues we will give you a free OWASP-SKF t-shirt! If you are really bad ass and you add major improvements then you will receive a hoodie of OWASP-SKF with your name on it!
Below are the 2 different parts of SKF and how you can contribute to it, please always make sure that the quality we try to achieve remains intact. Also when you have questions or want to discuss your implementation / contribution please locate us on Gitter.im chat:
Again thank you for your help, you rock!
- Fork and clone https://github.com/blabla1337/skf-flask
- pip3.6 install -r requirements.txt
- export FLASK_APP=skf/app.py
- export PYTHONPATH=.:$PYTHONPATH
- export FLASK_DEBUG=1
- python3.6 skf/app.py
- Run the manual test first to verify if everything is good
coverage run tests/run.py test
- Create your changes and write a unit test, commit and open a PR from your fork to the master repo. All CI test must pass before we accept pull requests.
- Fork and clone https://github.com/blabla1337/skf-flask
- cd Angular
- npm install
- ng serve --host=0.0.0.0
- OR edit the package.json in Angular folder and remove --env=prod example: "start": "ng serve --host=0.0.0.0"
- npm start
- Run the manual test in the Angular dir first to verify if everything is good
npm test
- Create your changes and write a unit test, commit and open a PR from your fork to the master repo. All CI test must pass before we accept pull requests.
TESTING SKF-API
Go to the SKF root dir and run:
export FLASK_APP=skf/app.py
export PYTHONPATH=.:$PYTHONPATH
export FLASK_DEBUG=1
coverage run tests/run.py test
TESTING SKF-ANGULAR
Go to the Angular dir in the SKF root dir and run:
npm test