-
Notifications
You must be signed in to change notification settings - Fork 51
Github specific workflow refactors and documentations #517
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
64813ad
Update github specific files
jamesrweb a5519e2
Add appropriate emojis for the conventional commits
jamesrweb f0dfdf4
Make dependabot updates monthly
jamesrweb 5072943
Migrate all CodeQL steps to v3
jamesrweb 38b39c2
Remove category arguments for now
jamesrweb 4dab3a8
Add the contributor covenant code of conduct
jamesrweb 7932b43
Make sure coverage is generated for upload
jamesrweb 25b2070
Add code coverage comments to PRs
jamesrweb f6a5b0b
testing
jamesrweb c2570c8
Add some uniqueness to artifact names and allow continuation on failu…
jamesrweb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| @jamesrweb @yevdyko | ||
| * @jamesrweb @yevdyko |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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/>. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
||
| ## 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 --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.