You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-3Lines changed: 26 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -8,24 +8,47 @@ Thank you for wanting to contribute to the PyScript project!
8
8
*[Contributing](#contributing)
9
9
*[Reporting issues](#reporting-issues)
10
10
*[Asking questions](#asking-questions)
11
+
*[Setting up your environment](#setting-up-your-environment)
11
12
12
13
##Code of Conduct
13
14
14
15
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.
15
16
16
17
##Contributing
17
18
18
-
###Reportingissues
19
+
###Reportingbugs
19
20
20
-
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.
21
+
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.
22
+
23
+
####Creating useful issues
24
+
25
+
* Use a clear and descriptive title
26
+
* Describe the specific steps that reproduce the problem, with as many details as possible so that someone can verify the issue
27
+
* Describe the behavior you observed at the steps described, and the behavior you had expected
28
+
* include screenshots if they help make the issue clear
21
29
22
30
###Asking questions
23
31
24
32
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)
25
33
26
34
###Setting up your environment
27
35
28
-
36
+
* clone the repo
37
+
```
38
+
git clone https://github.com/pyscript/pyscript
39
+
```
40
+
* cd into the main project folder
41
+
```
42
+
cd pyscript/pyscriptjs
43
+
```
44
+
* install the dependencies with npm install - make sure to use nodejs version >= 16
45
+
```
46
+
npm install
47
+
```
48
+
* run npm run dev to build and run the dev server. This will also watch for changes and rebuild when a file is saved
49
+
```
50
+
npm run dev
51
+
```
29
52
30
53
31
54
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.
