Add documentation for setting up repo for development
castastrophe opened this issue · 11 comments
It was brought to our attention that this project doesn't have a file with instructions on setting up the project for development.
Hello there, this would be my first meaningful contribution to the Open Source. Is this something a beginner can take up? Thank you.
Documentation is a great way to get your feet wet with open source. I'm not sure if this is the best place to jump in though. There's nothing to get you started so you'd have to parse the package.json and intuit which scripts to run.
Can I work on this issue?
@DARK-art108 You're welcome to pick this up if you like. We're hoping to add the following items:
- Add a Quick start to the README, example here
- Contribution guidelines, example here
The package.json contains the definition of the scripts available. The project was set up using webpack as the compiler.
I have added a quick start guide for setup the repo in development mode please review it.
@DARK-art108 Are you able to open a pull request?
Yes,I have opened a pull request recently.
Pls, review the pull request #238 @castastrophe
Pls, review the pull request #239 @castastrophe
Pls, review the pull request #239 @castastrophe