HTBox / allReady

This repo contains the code for allReady, an open-source solution focused on increasing awareness, efficiency and impact of preparedness campaigns as they are delivered by humanitarian and disaster response organizations in local communities.
http://www.htbox.org/projects/allready
MIT License
891 stars 624 forks source link

Doc Improvement on Dev Guidance and Build Process Trouble Shooting #2357

Open Chopinsky opened 4 years ago

Chopinsky commented 4 years ago

This PR is trying to improve the documentations for developers on where to start before contributing to the project. There are some very good instructions on how to launch and build the projects, however, in my opinion it's buried quite deeply and its location is not so obvious for a first-time contributor, it took me some time to eventually find the detailed steps on how to start and launch the project. So I have added a few paragraphs in the README.md and CONTRIBUTING.md to guide new contributors on where to start with.

In addition, I have added a section on trouble shooting a possible cause of a failed web package dependency build, where the dependency packages are not automatically installed when launching Visual Studio. I have also attached a screen shot of where to look to fix the issue.

Please let me know if I need to make further updates on the wordings or instructions.