SasanLabs / VulnerableApp-facade

VulnerableApp-facade is probably most modern lightweight distributed farm of Vulnerable Applications built for handling wide range of vulnerabilities across tech stacks.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Create documentation for contributors

Dripcoding opened this issue · comments

Is your feature request related to a problem? Please describe.
Contributors should have documentation that will make it easier for them to contribute to the project.
This documentation should contain steps to:

  • install project locally
  • run tests and tools locally
  • open pull requests
  • install required tools like Docker
  • recommend best practices and link to resources for technologies used

Describe the solution you'd like
I'd like to see a Contributing.md that will act as a starting point for all contributors.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
I've considered using a solution like docsifjs to create a documentation site. However I prefer to keep things simple at the start.

Additional context
Add any other context or screenshots about the feature request here.

Would you like to help fix this issue?
Just say if you'd like to try and help fix this issue. We'll provide any advice and guidance you need.

I'd like to help with this issue.

also integrate running of the unit test along with PR build in Github actions.