Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
@jamesrweb @yevdyko
* @jamesrweb @yevdyko
126 changes: 126 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [INSERT CONTACT
METHOD]. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the
[Contributor Covenant](https://www.contributor-covenant.org/), version 2.1,
available at
<https://www.contributor-covenant.org/version/2/1/code_of_conduct/>.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).

For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq/>. Translations are available at
<https://www.contributor-covenant.org/translations/>.
48 changes: 45 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,55 @@
<!--
Thank you for contributing to @p5-wrapper/react!
Please fill out this template to help us address your issue as quickly as possible.
-->

## Issue Type

<!-- Please check one or more that apply by replacing [ ] with [x] -->

- [ ] 🐛 Bug Report
- [ ] 💡 Feature Request
- [ ] 📝 Documentation Issue
- [ ] 🤔 Question
- [ ] 🧹 Chore
- [ ] ❓Other
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] ❓Other
- [ ] Other


## Description

<!-- A clear and concise description of the issue -->

## Expected Behavior

<!-- What did you expect to happen? -->

## Actual Behavior

## Steps to Reproduce the Problem
<!-- What actually happened? Include screenshots if applicable -->

## Steps to Reproduce

<!-- For bugs, provide detailed steps to reproduce the issue -->

1.
2.
3.

## Specifications
## Possible Solution

<!-- Optional: Do you have any suggestions on how to fix the issue? -->

## Environment

- Package Version: <!-- e.g., 5.0.0-rc.3 -->
- React Version: <!-- e.g., 19.1.0 -->
- Browser: <!-- e.g., Chrome 124, Firefox 126 -->
- OS: <!-- e.g., macOS 15.5, Windows 11 24H2 -->
- Node.js Version: <!-- e.g., 22.17.1 -->

## Additional Context

<!-- Add any other context about the problem here -->

## Minimal Reproduction

Package Version:
<!-- If possible, provide a CodeSandbox or similar link that demonstrates the issue -->
61 changes: 60 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,68 @@
<!--
Thank you for contributing to @p5-wrapper/react!
Please fill out this template to help us review your PR as quickly as possible.
-->

## Related Issue

<!-- Please link to the issue this PR resolves -->

Fixes #

## PR Type

<!-- Please check one or more that apply by replacing [ ] with [x] -->

- [ ] 🐛 Bug Fix
- [ ] ✨ New Feature
- [ ] 🔨 Code Refactor
- [ ] 📝 Documentation Update
- [ ] 🧪 Test Update
- [ ] 🔧 Build/CI Update
- [ ] 🧹 Chore
- [ ] ⏪ Revert

## Description

<!-- Please provide a clear and concise description of the changes made in this PR -->

## Proposed Changes

<!-- List the specific changes made in this PR -->

-
-
-

## Additional Notes (optional)
## How Has This Been Tested?

<!-- Please describe how you tested your changes -->

- [ ] Unit Tests
- [ ] Integration Tests
- [ ] Manual Testing (please describe)

## Screenshots/Recordings

<!-- If applicable, add screenshots or recordings to demonstrate the changes -->

## Breaking Changes

<!-- Does this PR introduce breaking changes? If yes, please describe -->

- [ ] Yes (please describe)
- [ ] No

## Checklist

<!-- Please check all that apply by replacing [ ] with [x] -->

- [ ] My code follows the code style of this project
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] All new and existing tests passed
- [ ] My changes generate no new warnings

## Additional Notes

<!-- Any additional information that might be helpful for reviewers -->
File renamed without changes.
48 changes: 37 additions & 11 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,46 @@

| Version | Supported | Supported Until |
| -------- | ------------------ | ----------------------------- |
| >= 4.x.x | :white_check_mark: | Next major version + 6 months |
| >= 3.0.0 | :x: | 01.06.22 |
| <= 3.0.0 | :x: | N / A |
| >= 5.x.x | :white_check_mark: | Next major version + 6 months |
| >= 4.x.x | :white_check_mark: | 2026-01-18 |
| >= 3.0.0 | :x: | 2022-06-01 |
| <= 3.0.0 | :x: | N/A |

## Reporting a Vulnerability

To report a security vulnerability please
[open a new issue](https://github.com/p5-wrapper/react/issues/new) with the
label `security`. Security issues are a priority, and we aim to resolve them
within 48 hours. If a security vulnerability cannot be resolved by us, we will
raise the issue upstream with relevant parties such as 3rd party package
managers.
To report a security vulnerability, please follow these steps:

1. **For non-critical issues**:
[Open a new issue](https://github.com/p5-wrapper/react/issues/new) and select
the "Bug Report" template. Add the `security` label to your issue.
2. **For critical vulnerabilities**: Please report them by tagging the core
maintainers directly (see the [Contacts section](#contacts) below).

Security issues are a priority, and we aim to resolve them within 48 hours. If
we cannot resolve a security vulnerability in the wrapper itself, we will raise
the issue upstream with relevant parties such as 3rd party package maintainers
where possible.

## Security Updates

We regularly update our dependencies to patch security vulnerabilities. We use
Dependabot to automate this process, which creates pull requests for security
updates monthly.

## Contacts

If you need to reach out regarding a security issue that is critically urgent
then you can reach out directly to @jamesrweb.
For **critical** security issues, please tag:

- James Robb ([@jamesrweb](https://github.com/jamesrweb))
- Eugene Dyko ([@yevdyko](https://github.com/yevdyko))

## Disclosure Policy

When we receive a security bug report, we will:

1. Confirm the vulnerability and determine its impact
2. Develop a fix and release it according to severity
3. Publish a security advisory if necessary

We appreciate your help in keeping
[@p5-wrapper/react](https://github.com/p5-wrapper/react) secure!
60 changes: 40 additions & 20 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,52 @@
# Support Guidelines

This repository is maintained by the @jamesrweb and the community, who all
volunteer their time.

We track bugs, user questions, suggestions and requests through
[issues](https://github.com/p5-wrapper/react/issues) raised via the project
repository issues tab.
We track bugs, user questions, suggestions, and requests through
[issues](https://github.com/p5-wrapper/react/issues).

## Need help with something?

All questions should be raised in
[an issue](https://github.com/p5-wrapper/react/issues/new) with the `question`
tag and the `help wanted` tag added to the issue.
If you need help with using the library or have questions about its
functionality:

1. Check the [documentation](https://github.com/p5-wrapper/react#readme) first
2. Search for [existing issues](https://github.com/p5-wrapper/react/issues) that
might address your question
3. If you can't find an answer, create
[a new issue](https://github.com/p5-wrapper/react/issues/new) with the
`question` tag

## Found a bug?

All bugs should be raised in
[an issue](https://github.com/p5-wrapper/react/issues/new) with the `bug` tag
added to the issue.
If you've discovered a bug in the library:

1. Check if it's already been reported in the
[issues](https://github.com/p5-wrapper/react/issues)
2. If not, create [a new issue](https://github.com/p5-wrapper/react/issues/new)
with the `bug` tag
3. Include steps to reproduce the issue, then explain what the expected and
actual behaviors are

## Thought of a cool new feature?

If you have an idea for a new feature or enhancement:

1. Check if it's already been suggested in the
[issues](https://github.com/p5-wrapper/react/issues)
2. If not, create [a new issue](https://github.com/p5-wrapper/react/issues/new)
with the `enhancement` tag
3. Describe the feature and why it would be valuable for your use case

## Community Support

## Though of a cool new feature?
For general questions about p5.js (not specific to this wrapper), you can also
check:

All bugs should be raised in
[an issue](https://github.com/p5-wrapper/react/issues/new) with the
`enhancement` tag added to the issue.
- [p5.js forum](https://discourse.processing.org/c/p5js/10)
- [p5.js reference](https://p5js.org/reference/)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/p5.js)

## Have questions about the project?
## Code of Conduct

All questions should be raised in
[an issue](https://github.com/p5-wrapper/react/issues/new) with the `question`
tag added to the issue.
Please note that this project adheres to a
[Code of Conduct](https://github.com/p5-wrapper/react/blob/master/CODE_OF_CONDUCT.md).
By participating in this project, you agree to abide by its terms.
Loading
Loading