8000 168 add contributing assets (#268) · fourmia/pyscript@d645722 · GitHub
[go: up one dir, main page]

Skip to content

Commit d645722

Browse files
kevingoldsmithKevin Goldsmithmattkram
authored
168 add contributing assets (pyscript#268)
* checkpoint: added some text * checkpoint: added setting up the environment, tips for writing good issues * continuing to fill it out * added more detailed description of the process of creating a change and some other cleanup. * added a getting started section and cleaned up the grammar. This ready for the PR now * forgot to add the new section to the TOC Co-authored-by: Kevin Goldsmith <kgoldsmith@anaconda.com> Co-authored-by: Matt Kramer <mkramer@anaconda.com>
1 parent d16cf8c commit d645722

File tree

1 file changed

+89
-3
lines changed

1 file changed

+89
-3
lines changed

CONTRIBUTING.md

Lines changed: 89 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,96 @@
1-
# Contributing
1+
# Contributing to PyScript
2+
3+
Thank you for wanting to contribute to the PyScript project!
4+
5+
## Table of contents
6+
7+
* [Code of Conduct](#code-of-conduct)
8+
* [Contributing](#contributing)
9+
* [Reporting bugs](#reporting-bugs)
10+
* [Reporting security issues](#reporting-security-issues)
11+
* [Asking questions](#asking-questions)
12+
* [Setting up your environment](#setting-up-your-environment)
13+
* [Places to start](#places-to-start)
14+
* [Submitting a change](#submitting-a-change)
15+
* [License terms for contributions](#license-terms-for-contributions)
16+
* [Becoming a maintainer](#becoming-a-maintainer)
17+
* [Trademarks](#trademarks)
18+
19+
## Code of Conduct
20+
21+
The [PyScript Code of Conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md) governs the project and everyone participating in it. By participating, you are expected to uphold this code. Please report unacceptable behavior to the maintainers or administrators as described in that document.
22+
23+
## Contributing
24+
25+
### Reporting bugs
26+
27+
Bugs are tracked on the [project issues page](https://github.com/pyscript/pyscript/issues). Please check 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.
28+
29+
#### Creating useful issues
30+
31+
* Use a clear and descriptive title.
32+
* Describe the specific steps that reproduce the problem with as many details as possible so that someone can verify the issue.
33+
* Describe the behavior you observed, and the behavior you had expected.
34+
* Include screenshots if they help make the issue clear.
35+
36+
### Reporting security issues
37+
38+
If you aren't confident that it is appropriate to submit a security issue using the above process, you can e-mail it to security@pyscript.net
39+
40+
### Asking questions
41+
42+
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).
43+
44+
### Setting up your environment
45+
46+
* clone the repo
47+
```
48+
git clone https://github.com/pyscript/pyscript
49+
```
50+
* cd into the main project folder
51+
```
52+
cd pyscript/pyscriptjs
53+
```
54+
* install the dependencies with npm install - make sure to use nodejs version >= 16
55+
```
56+
npm install
57+
```
58+
* run npm run dev to build and run the dev server. This will also watch for changes and rebuild when a file is saved.
59+
```
60+
npm run dev
61+
```
62+
63+
### Places to start
64+
65+
If you would like to contribute to PyScript, but you aren't sure where to begin, here are some suggestions.
66+
67+
* **Read over the existing documentation.** Are there things missing, or could they be clearer? Make some changes/additions to those documents.
68+
* **Review the open issues.** Are they clear? Can you reproduce them? You can add comments, clarifications, or additions to those issues. If you think you have an idea of how to address the issue, submit a fix!
69+
* **Look over the open pull requests.** Do you have comments or suggestions for the proposed changes? Add them.
70+
* **Check out the examples.** Is there a use case that would be good to have sample code for? Create an example for it.
71+
72+
### Submitting a change
73+
74+
All contributions must be licensed Apache 2.0, and all files must have a copy of the boilerplate license comment (can be copied from an existing file).
75+
76+
To create a change for PyScript, you can follow the process described [here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
77+
78+
* Fork a personal copy of the PyScript project.
79+
* Make the changes you would like (don't forget to test them!)
80+
* Please squash all commits for a change into a single commit (this can be done using "git rebase -i"). Do your best to have a well-formed commit message for the change.
81+
* Open a pull request back to the PyScript project and address any comments/questions from the maintainers and other contributors.
82+
83+
## License terms for contributions
284

385
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.
486

5-
Contributors are invited to be maintainers to the project by demonstrating good decision making in their contributions, a commitment to goals of the project, and consistent adherence to the [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). New maintainers are invited by a 3/4 vote of the existing maintainers.
87+
## Becoming a maintainer
88+
89+
Contributors are invited to be maintainers to the project by demonstrating good decision making in their contributions, a commitment to the goals of the project, and consistent adherence to the [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). New maintainers are invited by a 3/4 vote of the existing maintainers.
90+
91+
## Trademarks
692

7-
The Project abides by the Organization's [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md) and [trademark policy](https://github.com/pyscript/governance/blob/main/TRADEMARKS.md).
93+
The Project abides by the Organization's [trademark policy](https://github.com/pyscript/governance/blob/main/TRADEMARKS.md).
894

995
---
1096
Part of MVG-0.1-beta.

0 commit comments

Comments
 (0)
0