Skip to content

Commit d5b5feb

Browse files
jamesrwebjamesrweb
authored
Github specific workflow refactors and documentations (#517)
1 parent 4c59191 commit d5b5feb

File tree

12 files changed

+692
-71
lines changed

12 files changed

+692
-71
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
@jamesrweb @yevdyko
1+
* @jamesrweb @yevdyko

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [INSERT CONTACT
63+
METHOD]. All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the
117+
[Contributor Covenant](https://www.contributor-covenant.org/), version 2.1,
118+
available at
119+
<https://www.contributor-covenant.org/version/2/1/code_of_conduct/>.
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
<https://www.contributor-covenant.org/faq/>. Translations are available at
126+
<https://www.contributor-covenant.org/translations/>.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,55 @@
1+
<!--
2+
Thank you for contributing to @p5-wrapper/react!
3+
Please fill out this template to help us address your issue as quickly as possible.
4+
-->
5+
6+
## Issue Type
7+
8+
<!-- Please check one or more that apply by replacing [ ] with [x] -->
9+
10+
- [ ] 🐛 Bug Report
11+
- [ ] 💡 Feature Request
12+
- [ ] 📝 Documentation Issue
13+
- [ ] 🤔 Question
14+
- [ ] 🧹 Chore
15+
- [ ] ❓Other
16+
17+
## Description
18+
19+
<!-- A clear and concise description of the issue -->
20+
121
## Expected Behavior
222

23+
<!-- What did you expect to happen? -->
24+
325
## Actual Behavior
426

5-
## Steps to Reproduce the Problem
27+
<!-- What actually happened? Include screenshots if applicable -->
28+
29+
## Steps to Reproduce
30+
31+
<!-- For bugs, provide detailed steps to reproduce the issue -->
632

733
1.
834
2.
935
3.
1036

11-
## Specifications
37+
## Possible Solution
38+
39+
<!-- Optional: Do you have any suggestions on how to fix the issue? -->
40+
41+
## Environment
42+
43+
- Package Version: <!-- e.g., 5.0.0-rc.3 -->
44+
- React Version: <!-- e.g., 19.1.0 -->
45+
- Browser: <!-- e.g., Chrome 124, Firefox 126 -->
46+
- OS: <!-- e.g., macOS 15.5, Windows 11 24H2 -->
47+
- Node.js Version: <!-- e.g., 22.17.1 -->
48+
49+
## Additional Context
50+
51+
<!-- Add any other context about the problem here -->
52+
53+
## Minimal Reproduction
1254

13-
Package Version:
55+
<!-- If possible, provide a CodeSandbox or similar link that demonstrates the issue -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,68 @@
1+
<!--
2+
Thank you for contributing to @p5-wrapper/react!
3+
Please fill out this template to help us review your PR as quickly as possible.
4+
-->
5+
6+
## Related Issue
7+
8+
<!-- Please link to the issue this PR resolves -->
9+
110
Fixes #
211

12+
## PR Type
13+
14+
<!-- Please check one or more that apply by replacing [ ] with [x] -->
15+
16+
- [ ] 🐛 Bug Fix
17+
- [ ] ✨ New Feature
18+
- [ ] 🔨 Code Refactor
19+
- [ ] 📝 Documentation Update
20+
- [ ] 🧪 Test Update
21+
- [ ] 🔧 Build/CI Update
22+
- [ ] 🧹 Chore
23+
- [ ] ⏪ Revert
24+
25+
## Description
26+
27+
<!-- Please provide a clear and concise description of the changes made in this PR -->
28+
329
## Proposed Changes
430

31+
<!-- List the specific changes made in this PR -->
32+
533
-
634
-
735
-
836

9-
## Additional Notes (optional)
37+
## How Has This Been Tested?
38+
39+
<!-- Please describe how you tested your changes -->
40+
41+
- [ ] Unit Tests
42+
- [ ] Integration Tests
43+
- [ ] Manual Testing (please describe)
44+
45+
## Screenshots/Recordings
46+
47+
<!-- If applicable, add screenshots or recordings to demonstrate the changes -->
48+
49+
## Breaking Changes
50+
51+
<!-- Does this PR introduce breaking changes? If yes, please describe -->
52+
53+
- [ ] Yes (please describe)
54+
- [ ] No
55+
56+
## Checklist
57+
58+
<!-- Please check all that apply by replacing [ ] with [x] -->
59+
60+
- [ ] My code follows the code style of this project
61+
- [ ] I have updated the documentation accordingly
62+
- [ ] I have added tests to cover my changes
63+
- [ ] All new and existing tests passed
64+
- [ ] My changes generate no new warnings
65+
66+
## Additional Notes
67+
68+
<!-- Any additional information that might be helpful for reviewers -->

‎README.md‎ renamed to ‎.github/README.md‎

File renamed without changes.

‎.github/SECURITY.md‎

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,46 @@
44

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

1112
## Reporting a Vulnerability
1213

13-
To report a security vulnerability please
14-
[open a new issue](https://github.com/p5-wrapper/react/issues/new) with the
15-
label `security`. Security issues are a priority, and we aim to resolve them
16-
within 48 hours. If a security vulnerability cannot be resolved by us, we will
17-
raise the issue upstream with relevant parties such as 3rd party package
18-
managers.
14+
To report a security vulnerability, please follow these steps:
15+
16+
1. **For non-critical issues**:
17+
[Open a new issue](https://github.com/p5-wrapper/react/issues/new) and select
18+
the "Bug Report" template. Add the `security` label to your issue.
19+
2. **For critical vulnerabilities**: Please report them by tagging the core
20+
maintainers directly (see the [Contacts section](#contacts) below).
21+
22+
Security issues are a priority, and we aim to resolve them within 48 hours. If
23+
we cannot resolve a security vulnerability in the wrapper itself, we will raise
24+
the issue upstream with relevant parties such as 3rd party package maintainers
25+
where possible.
26+
27+
## Security Updates
28+
29+
We regularly update our dependencies to patch security vulnerabilities. We use
30+
Dependabot to automate this process, which creates pull requests for security
31+
updates monthly.
1932

2033
## Contacts
2134

22-
If you need to reach out regarding a security issue that is critically urgent
23-
then you can reach out directly to @jamesrweb.
35+
For **critical** security issues, please tag:
36+
37+
- James Robb ([@jamesrweb](https://github.com/jamesrweb))
38+
- Eugene Dyko ([@yevdyko](https://github.com/yevdyko))
39+
40+
## Disclosure Policy
41+
42+
When we receive a security bug report, we will:
43+
44+
1. Confirm the vulnerability and determine its impact
45+
2. Develop a fix and release it according to severity
46+
3. Publish a security advisory if necessary
47+
48+
We appreciate your help in keeping
49+
[@p5-wrapper/react](https://github.com/p5-wrapper/react) secure!

‎.github/SUPPORT.md‎

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,52 @@
11
# Support Guidelines
22

3-
This repository is maintained by the @jamesrweb and the community, who all
4-
volunteer their time.
5-
6-
We track bugs, user questions, suggestions and requests through
7-
[issues](https://github.com/p5-wrapper/react/issues) raised via the project
8-
repository issues tab.
3+
We track bugs, user questions, suggestions, and requests through
4+
[issues](https://github.com/p5-wrapper/react/issues).
95

106
## Need help with something?
117

12-
All questions should be raised in
13-
[an issue](https://github.com/p5-wrapper/react/issues/new) with the `question`
14-
tag and the `help wanted` tag added to the issue.
8+
If you need help with using the library or have questions about its
9+
functionality:
10+
11+
1. Check the [documentation](https://github.com/p5-wrapper/react#readme) first
12+
2. Search for [existing issues](https://github.com/p5-wrapper/react/issues) that
13+
might address your question
14+
3. If you can't find an answer, create
15+
[a new issue](https://github.com/p5-wrapper/react/issues/new) with the
16+
`question` tag
1517

1618
## Found a bug?
1719

18-
All bugs should be raised in
19-
[an issue](https://github.com/p5-wrapper/react/issues/new) with the `bug` tag
20-
added to the issue.
20+
If you've discovered a bug in the library:
21+
22+
1. Check if it's already been reported in the
23+
[issues](https://github.com/p5-wrapper/react/issues)
24+
2. If not, create [a new issue](https://github.com/p5-wrapper/react/issues/new)
25+
with the `bug` tag
26+
3. Include steps to reproduce the issue, then explain what the expected and
27+
actual behaviors are
28+
29+
## Thought of a cool new feature?
30+
31+
If you have an idea for a new feature or enhancement:
32+
33+
1. Check if it's already been suggested in the
34+
[issues](https://github.com/p5-wrapper/react/issues)
35+
2. If not, create [a new issue](https://github.com/p5-wrapper/react/issues/new)
36+
with the `enhancement` tag
37+
3. Describe the feature and why it would be valuable for your use case
38+
39+
## Community Support
2140

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

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

28-
## Have questions about the project?
48+
## Code of Conduct
2949

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

0 commit comments

Comments
 (0)