mirror of
https://github.com/pyscript/pyscript.git
synced 2025-12-19 18:27:29 -05:00
543a27271f
* Fix markdown Add event-handlers.md * Address changes from Jeff + Antonion and add it to index * how tos don't exist anymore theyre now guides * Restore p on contributing * Adding changelog * Aadd space * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: Carmelo <carmelofiorello@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
82 lines
4.8 KiB
Markdown
82 lines
4.8 KiB
Markdown
# Contributing to PyScript
|
|
|
|
Thank you for wanting to contribute to the PyScript project!
|
|
|
|
## Table of contents
|
|
|
|
- [Contributing to PyScript](#contributing-to-pyscript)
|
|
- [Table of contents](#table-of-contents)
|
|
- [Code of Conduct](#code-of-conduct)
|
|
- [Contributing](#contributing)
|
|
- [Reporting bugs](#reporting-bugs)
|
|
- [Creating useful issues](#creating-useful-issues)
|
|
- [Reporting security issues](#reporting-security-issues)
|
|
- [Asking questions](#asking-questions)
|
|
- [Setting up your local environment and developing](#setting-up-your-local-environment-and-developing)
|
|
- [Developing](#developing)
|
|
- [Rebasing changes](#rebasing-changes)
|
|
- [Building the docs](#building-the-docs)
|
|
- [Places to start](#places-to-start)
|
|
- [Setting up your local environment and developing](#setting-up-your-local-environment-and-developing)
|
|
- [Submitting a change](#submitting-a-change)
|
|
- [License terms for contributions](#license-terms-for-contributions)
|
|
- [Becoming a maintainer](#becoming-a-maintainer)
|
|
- [Trademarks](#trademarks)
|
|
|
|
# Code of Conduct
|
|
|
|
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.
|
|
|
|
# Contributing
|
|
|
|
## Reporting bugs
|
|
|
|
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.
|
|
|
|
## 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, and the behavior you had expected.
|
|
- Include screenshots if they help make the issue clear.
|
|
|
|
## Reporting security issues
|
|
|
|
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
|
|
|
|
## 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).
|
|
|
|
## Places to start
|
|
|
|
If you would like to contribute to PyScript, but you aren't sure where to begin, here are some suggestions:
|
|
|
|
- **Read over the existing documentation.** Are there things missing, or could they be clearer? Make some changes/additions to those documents.
|
|
- **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!
|
|
- **Look over the open pull requests.** Do you have comments or suggestions for the proposed changes? Add them.
|
|
- **Check out the examples.** Is there a use case that would be good to have sample code for? Create an example for it.
|
|
|
|
## Setting up your local environment and developing
|
|
|
|
If you would like to contribute to PyScript, you will need to set up a local development environment. The [following instructions](https://docs.pyscript.net/latest/development/setting-up-environment.html) will help you get started.
|
|
|
|
You can also read about PyScript's [development process](https://docs.pyscript.net/latest/development/developing.html) to learn how to contribute code to PyScript, how to run tests and what's the PR etiquette of the community!
|
|
|
|
## License terms for contributions
|
|
|
|
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.
|
|
|
|
## Becoming a maintainer
|
|
|
|
Contributors are invited to be maintainers of 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.
|
|
|
|
## Trademarks
|
|
|
|
The Project abides by the Organization's [trademark policy](https://github.com/pyscript/governance/blob/main/TRADEMARKS.md).
|
|
|
|
---
|
|
|
|
Part of MVG-0.1-beta.
|
|
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
|