checkpoint: added setting up the environment, tips for writing good issues

Kevin Goldsmith · Kevin Goldsmith · commit 550677db405a · 2022-05-05T19:07:46.000-06:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,24 +8,47 @@ Thank you for wanting to contribute to the PyScript project!
 * [Contributing](#contributing)
     * [Reporting issues](#reporting-issues)
     * [Asking questions](#asking-questions)
+    * [Setting up your environment](#setting-up-your-environment)
 
 ## Code of Conduct
 
 The project and everyone participating in it is governed by the [PyScript Code of Conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the maintainers or administrators.
 
 ## Contributing
 
-### Reporting issues
+### Reporting bugs
 
-Issues should be filed on the [project issues page](https://github.com/pyscript/pyscript/issues). Please check to see if your issue has already been filed by someone else by searching the existing issues before filing a new one. Once your issue is filed, it will be triaged by another contributor or maintainer. If there are questions raised about your issue, please respond promptly.
+Bugs are tracked on the [project issues page](https://github.com/pyscript/pyscript/issues). Please check to see if your issue has already been filed by someone else by searching the existing issues before filing a new one. Once your issue is filed, it will be triaged by another contributor or maintainer. If there are questions raised about your issue, please respond promptly.
+
+#### Creating useful issues
+
+* Use a clear and descriptive title
+* Describe the specific steps that reproduce the problem, with as many details as possible so that someone can verify the issue
+* Describe the behavior you observed at the steps described, and the behavior you had expected
+* include screenshots if they help make the issue clear
 
 ### Asking questions
 
 If you have questions about the project, using PyScript, or anything else please ask in the [PyScript forum](https://community.anaconda.cloud/c/tech-topics/pyscript)
 
 ### Setting up your environment
 
-
+* clone the repo
+```
+    git clone https://github.com/pyscript/pyscript
+```
+* cd into the main project folder
+```
+    cd pyscript/pyscriptjs
+```
+* install the dependencies with npm install - make sure to use nodejs version >= 16
+```
+    npm install
+```
+* run npm run dev to build and run the dev server. This will also watch for changes and rebuild when a file is saved
+```
+    npm run dev
+```
 
 
 This Project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the [Apache 2.0](./LICENSE) license. You represent that if you do not own copyright in the code that you have the authority to submit it under the [Apache 2.0](./LICENSE) license. All feedback, suggestions, or contributions are not confidential.
