-
Couldn't load subscription status.
- Fork 8
Add Essential GitHub Repository Files (LICENSE, SUPPORT, PR Template, Issue Templates) #53
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
Changes from all commits
edada74
decbc2d
f28fc1c
3fb4ade
ae9b73f
488f72f
659aec8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| name: Bug report | ||
| description: Report a bug with the AI Experiments plugin | ||
| labels: ['[Type] Bug'] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! If this is a security issue, please report it privately (see SECURITY.md). | ||
| - type: textarea | ||
| attributes: | ||
| label: Description | ||
| description: Please write a brief description of the bug, including what you expect to happen and what is currently happening. | ||
| placeholder: | | ||
| Feature '...' is not working properly. I expect '...' to happen, but '...' happens instead | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Step-by-step reproduction instructions | ||
| description: Please write the steps needed to reproduce the bug. | ||
| placeholder: | | ||
| 1. Go to '...' | ||
| 2. Click on '...' | ||
| 3. Scroll down to '...' | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Screenshots, screen recording, code snippet | ||
| description: | | ||
| If possible, please upload a screenshot or screen recording which demonstrates the bug. You can use LICEcap to create a GIF screen recording: https://www.cockos.com/licecap/ | ||
| Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| If this bug is to related to a developer API, please share a code snippet that demonstrates the issue. For small snippets paste it directly here, or you can use GitHub Gist to share multiple code files: https://gist.github.com | ||
| Please ensure the shared code can be used by a developer to reproduce the issue—ideally it can be copied into a local development environment or executed in a browser console to help debug the issue | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Environment info | ||
| description: | | ||
| Please list what AI Experiments plugin version you are using. | ||
| placeholder: | | ||
| - WordPress version, AI Experiments plugin version, and active Theme you are using. | ||
| - Browser(s) are you seeing the problem on. | ||
| - Device you are using and operating system (e.g. "Desktop with Windows 10", "iPhone with iOS 14", etc.). | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: checkboxes | ||
| id: existing | ||
| attributes: | ||
| label: Please confirm that you have searched existing issues in the repo. | ||
| description: You can do this by searching https://github.com/WordPress/ai/issues and making sure the bug is not related to another plugin. | ||
| options: | ||
| - label: 'Yes' | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: plugins | ||
| attributes: | ||
| label: Please confirm that you have tested with all plugins deactivated except AI Experiments plugin. | ||
| options: | ||
| - label: 'Yes' | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: themes | ||
| attributes: | ||
| label: Please confirm which theme type you used for testing. | ||
| options: | ||
| - label: 'Block' | ||
| - label: 'Classic' | ||
| - label: 'Hybrid (e.g. classic with theme.json)' | ||
| - label: 'Not sure' | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Propose an idea for a feature or an enhancement | ||
| labels: "[Type] Enhancement" | ||
|
|
||
| --- | ||
|
|
||
| ## What problem does this address? | ||
| <!-- | ||
| Please describe if this feature or enhancement is related to a current problem | ||
| or pain point. For example, "I'm always frustrated when ..." or "It is currently | ||
| difficult to ...". | ||
| --> | ||
|
|
||
| ## What is your proposed solution? | ||
| <!-- | ||
| Please outline the feature or enhancement that you want and how it addresses any | ||
| problem identified above. | ||
| --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <!-- Thanks for contributing to the AI plugin! Please follow the AI Experiments Plugin Contributing Guidelines: | ||
| https://github.com/WordPress/ai/blob/trunk/CONTRIBUTING.md --> | ||
|
|
||
| ## What? | ||
| <!-- Link this PR to its associated issue with an appropriate keyword: Closes, See, Follow up to, etc. --> | ||
| Closes <!-- #ISSUE-NUMBER or URL --> | ||
|
|
||
| <!-- In a few words, what is the PR actually doing? --> | ||
|
|
||
| ## Why? | ||
| <!-- Why is this PR necessary? What problem is it solving? Reference any existing previous issue(s) or PR(s), but please add a short summary here, too --> | ||
|
|
||
| ## How? | ||
| <!-- How is your PR addressing the issue at hand? What are the implementation details? --> | ||
|
|
||
| ## Testing Instructions | ||
| <!-- Please include step by step instructions on how to test this PR. --> | ||
| <!-- 1. Open a post or page. --> | ||
| <!-- 2. Insert a heading block. --> | ||
| <!-- 3. etc. --> | ||
|
|
||
| ### Testing Instructions for Keyboard | ||
| <!-- How can you test the changes by using the keyboard only? Please note, this is required for PRs that change the user interface (UI). This ensures the PR can be tested for any possible accessibility regressions. --> | ||
|
|
||
| ## Screenshots or screencast <!-- if applicable --> | ||
|
|
||
| <!-- If you would like to upload screenshots, feel free to use the table below when it is useful to show the difference between before and after the change. --> | ||
|
|
||
| |Before|After| | ||
| |-|-| | ||
| |<!-- Before screenshot here -->|<!-- After screenshot here -->| |
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure we need this file, feels unnecessary on top of README.md and CONTRIBUTING.md. What's the thinking with adding in this file? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. https://github.com/WordPress/gutenberg/blob/trunk/.github/SUPPORT.md Gutenberg also has SUPPORT.md file and #42 also has several .md files There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The main idea was to provide a clear support reference within the repository itself, so contributors and users can easily find where to get help without relying solely on the README or CONTRIBUTING files. It helps improve discoverability and maintain consistency across WordPress projects. For example, the Gutenberg repository also includes a SUPPORT.md file for the same purpose. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # AI Plugin Project Support | ||
|
|
||
| Welcome to the AI plugin, a WordPress project. We hope you join us in exploring AI capabilities within WordPress; all are welcome here. | ||
|
|
||
| * Please see the [Contributing Guidelines](https://github.com/WordPress/ai/blob/trunk/CONTRIBUTING.md) for additional information on how to contribute. | ||
|
|
||
| * As with all WordPress projects, we want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [Code of Conduct](https://make.wordpress.org/handbook/community-code-of-conduct/). | ||
|
|
||
| * Join us on Slack for real-time communication, it is where maintainers coordinate around the project. To get started using Slack, see: https://make.wordpress.org/chat/ | ||
|
|
||
| * For general WordPress support with the core editor, see the [WordPress.org support forums](https://wordpress.org/support/forums/) — it is highly active and well maintained. |
Uh oh!
There was an error while loading. Please reload this page.