Compare commits
3 Commits
Author | SHA1 | Date | |
---|---|---|---|
66758ac0f8 | |||
32697533ab | |||
4a7798a8c2 |
@ -16,7 +16,7 @@ This workspace may contain multiple repository folders. Always focus ONLY on the
|
||||
- **Plugin Slug**: wp-plugin-starter-template
|
||||
- **Text Domain**: wp-plugin-starter-template
|
||||
- **Namespace**: WPALLSTARS\PluginStarterTemplate
|
||||
- **Version**: 0.1.0
|
||||
- **Version**: 0.1.1
|
||||
- **Requires WordPress**: 5.0+
|
||||
- **Requires PHP**: 7.0+
|
||||
- **License**: GPL-2.0+
|
||||
|
59
.ai-workflows/folder-structure.md
Normal file
59
.ai-workflows/folder-structure.md
Normal file
@ -0,0 +1,59 @@
|
||||
# Folder Structure
|
||||
|
||||
This document outlines the folder structure of the plugin and explains the purpose of each directory.
|
||||
|
||||
## Root Directories
|
||||
|
||||
- **admin/** - Contains admin-specific functionality and assets
|
||||
- **includes/** - Contains core plugin functionality and classes
|
||||
- **languages/** - Contains translation files
|
||||
- **scripts/** - Contains build and deployment scripts
|
||||
- **.ai-workflows/** - Contains documentation for AI assistants
|
||||
- **.github/** - Contains GitHub-specific files like workflows
|
||||
- **.wordpress-org/** - Contains WordPress.org assets like banners and screenshots
|
||||
|
||||
## Admin Directory Structure
|
||||
|
||||
- **admin/css/** - Admin-specific CSS files
|
||||
- **admin/js/** - Admin-specific JavaScript files
|
||||
- **admin/images/** - Admin-specific images
|
||||
- **admin/partials/** - Admin-specific template partials
|
||||
- **admin/settings/** - Admin settings functionality
|
||||
- **admin/tools/** - Admin tools functionality
|
||||
- **admin/lib/** - Admin-specific library files and helper functions
|
||||
- **admin/lib/admin.php** - Admin class for handling admin-specific functionality
|
||||
- **admin/lib/modal.php** - Modal class for handling the update source selector modal
|
||||
|
||||
## Includes Directory
|
||||
|
||||
The `includes/` directory contains the core plugin functionality:
|
||||
|
||||
- **includes/core.php** - Core class for handling the main plugin functionality
|
||||
- **includes/plugin.php** - Main plugin class that initializes all components
|
||||
- **includes/updater.php** - Updater class for handling plugin updates
|
||||
|
||||
## File Naming Conventions
|
||||
|
||||
- All PHP files in the `includes/` directory use lowercase filenames
|
||||
- All directories use lowercase names
|
||||
- JavaScript and CSS files use kebab-case (e.g., `update-source-selector.js`)
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Unique Directory Names**: Each directory should have a unique name to avoid confusion
|
||||
2. **Logical Organization**: Files should be organized logically by function
|
||||
3. **Consistent Naming**: File and directory names should follow consistent naming conventions
|
||||
4. **Clear Separation**: Admin functionality should be separate from core functionality
|
||||
5. **Minimal Dependencies**: Files should have minimal dependencies on other files
|
||||
|
||||
## @mentions for AI Assistants
|
||||
|
||||
When referring to files or directories in AI conversations, use the following format:
|
||||
|
||||
- **@includes/plugin.php** - Main plugin class
|
||||
- **@includes/core.php** - Core functionality
|
||||
- **@admin/lib/admin.php** - Admin functionality
|
||||
- **@admin/lib/modal.php** - Modal functionality
|
||||
- **@includes/updater.php** - Updater functionality
|
||||
- **@admin/js/update-source-selector.js** - Update source selector JavaScript
|
||||
- **@admin/css/update-source-selector.css** - Update source selector CSS
|
225
.ai-workflows/incremental-development.md
Normal file
225
.ai-workflows/incremental-development.md
Normal file
@ -0,0 +1,225 @@
|
||||
# Incremental Development and Testing Guide
|
||||
|
||||
This document provides guidance for AI assistants to help with incremental development and testing for the Fix Plugin Does Not Exist Notices plugin.
|
||||
|
||||
## Time-Efficient Development Principles
|
||||
|
||||
### Branch Naming for Development
|
||||
|
||||
1. **Initial Development Branches**
|
||||
- Use descriptive names without version numbers:
|
||||
- `fix/issue-description` - For bug fixes
|
||||
- `feature/descriptive-name` - For new features
|
||||
- `patch/descriptive-name` - For small improvements
|
||||
- `refactor/descriptive-name` - For code restructuring
|
||||
- **Don't update version numbers** during this phase
|
||||
- Focus on implementing and testing the changes
|
||||
|
||||
2. **Version Branches**
|
||||
- Only create after changes are confirmed working:
|
||||
- `v{MAJOR}.{MINOR}.{PATCH}` (e.g., `v2.2.3`)
|
||||
- Only update version numbers at this point
|
||||
- This minimizes unnecessary version updates
|
||||
|
||||
### Version Numbering Guidelines
|
||||
|
||||
1. **Patch Versions (X.Y.Z → X.Y.Z+1)**
|
||||
- Use for bug fixes and small improvements
|
||||
- Example: `v2.2.3`
|
||||
|
||||
2. **Minor Versions (X.Y.Z → X.Y+1.0)**
|
||||
- Use for new features or significant improvements
|
||||
- Example: `v2.3.0`
|
||||
|
||||
3. **Major Versions (X.Y.Z → X+1.0.0)**
|
||||
- Only increment when numerous features and fixes are tested and confirmed stable
|
||||
- Reserved for breaking changes or significant overhauls
|
||||
- Example: `v3.0.0`
|
||||
|
||||
### Marking Stable Versions
|
||||
|
||||
When the user confirms that changes are working correctly:
|
||||
1. Create a version branch and update version numbers
|
||||
2. Tag the version branch as stable
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
3. Document in the PR or issue that this version has been confirmed stable
|
||||
|
||||
## Local Testing Workflow
|
||||
|
||||
### 1. Create a Descriptive Branch for Development
|
||||
|
||||
```bash
|
||||
# Ensure you have the latest main branch
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# Create a descriptive branch (without version numbers)
|
||||
git checkout -b fix/plugin-activation-error
|
||||
```
|
||||
|
||||
### 2. Make Changes Without Updating Version Numbers
|
||||
|
||||
During the development and testing phase:
|
||||
- Implement the necessary changes
|
||||
- **Don't update version numbers** in any files yet
|
||||
- Focus on the functionality
|
||||
|
||||
### 3. Build and Deploy Locally
|
||||
|
||||
For local testing, use the current version number from the main plugin file:
|
||||
|
||||
```bash
|
||||
# Get the current version from the plugin file
|
||||
CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notices.php | cut -d' ' -f2)
|
||||
|
||||
# Build and deploy with current version
|
||||
./build.sh $CURRENT_VERSION
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Create a build directory
|
||||
2. Copy required files to the build directory
|
||||
3. Deploy the plugin to your local WordPress testing environment
|
||||
|
||||
**Note**: For local testing iterations, you do not need to commit changes, push to remote repositories, or create tags unless specifically requested.
|
||||
|
||||
### 4. Test and Evaluate
|
||||
|
||||
Test the changes thoroughly in the local environment:
|
||||
- Verify that the specific issue is fixed or feature works as expected
|
||||
- Check for any regressions or new issues
|
||||
- Document the results
|
||||
|
||||
### 5. Based on Testing Results
|
||||
|
||||
- **If changes need further refinement**: Continue working in the same branch
|
||||
- **If changes work as expected**: Proceed to version branch creation
|
||||
|
||||
### 6. Creating a Version Branch
|
||||
|
||||
When changes are confirmed working and ready for release:
|
||||
|
||||
1. Create a version branch with the appropriate version number:
|
||||
|
||||
```bash
|
||||
# Determine the appropriate version increment (patch, minor, or major)
|
||||
# based on the nature of the changes
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
2. Now update version numbers in all required files:
|
||||
|
||||
- Main plugin file (wp-fix-plugin-does-not-exist-notices.php)
|
||||
- CHANGELOG.md (add a new version section)
|
||||
- readme.txt
|
||||
- README.md
|
||||
- languages/wp-fix-plugin-does-not-exist-notices.pot (Project-Id-Version)
|
||||
|
||||
3. Commit the version updates:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - [brief description]"
|
||||
```
|
||||
|
||||
4. Tag the version as stable:
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
## Remote Testing Workflow
|
||||
|
||||
When the user specifically requests remote testing:
|
||||
|
||||
### 1. Commit Changes to Remote Repository
|
||||
|
||||
If testing a development branch (without version updates):
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "[brief description] for remote testing"
|
||||
git push origin [branch-name]
|
||||
```
|
||||
|
||||
If testing a version branch (with version updates):
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - [brief description]"
|
||||
git push origin v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 2. Create and Push Tag (For Version Branches Only)
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} for remote testing"
|
||||
git push origin v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
This will trigger GitHub Actions to build the installable ZIP file.
|
||||
|
||||
### 3. Verify Remote Build
|
||||
|
||||
Check that the GitHub Actions workflow completed successfully and the ZIP file is available for download.
|
||||
|
||||
### 4. Test and Evaluate
|
||||
|
||||
Test the remotely built version and document the results.
|
||||
|
||||
## Contributing to External Repositories
|
||||
|
||||
When working on issues for external repositories (pull/merge requests):
|
||||
|
||||
### 1. Clearly Indicate Testing Status
|
||||
|
||||
In the PR description and comments, clearly indicate the testing status:
|
||||
|
||||
- **Not tested**: "This PR addresses [issue] but has not been tested locally or remotely. It's ready for community/maintainer testing."
|
||||
- **Locally tested**: "This PR has been tested in a local WordPress environment and [describe results]."
|
||||
- **Remotely tested**: "This PR has been tested with a remote build and [describe results]."
|
||||
|
||||
### 2. Provide Testing Instructions
|
||||
|
||||
Include clear instructions for maintainers on how to test the changes:
|
||||
|
||||
- Steps to reproduce the original issue (if applicable)
|
||||
- Steps to verify the fix or feature
|
||||
- Any specific environments or configurations needed for testing
|
||||
|
||||
### 3. Be Responsive to Feedback
|
||||
|
||||
Monitor the PR for feedback from maintainers and be prepared to make additional changes if requested.
|
||||
|
||||
## Rollback Procedure
|
||||
|
||||
If a change causes issues after release:
|
||||
|
||||
### 1. Identify the Last Stable Version
|
||||
|
||||
Find the last version that was marked as stable:
|
||||
|
||||
```bash
|
||||
git tag -l "*-stable"
|
||||
```
|
||||
|
||||
### 2. Create a New Branch from the Stable Version
|
||||
|
||||
```bash
|
||||
git checkout v{MAJOR}.{MINOR}.{PATCH}-stable
|
||||
git checkout -b fix/rollback-based-fix
|
||||
```
|
||||
|
||||
### 3. Make Necessary Changes
|
||||
|
||||
Implement the fix based on the stable version. Don't update version numbers yet.
|
||||
|
||||
### 4. Test the Changes
|
||||
|
||||
Test thoroughly to ensure the fix resolves the issues.
|
||||
|
||||
### 5. When Confirmed Working
|
||||
|
||||
Create a version branch with an incremented patch version and update all version numbers as described in the "Creating a Version Branch" section.
|
@ -1,5 +1,9 @@
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
#### [0.1.1] - 2025-04-18
|
||||
#### Changed
|
||||
- Updated LICENSE file with correct GPL-2.0 text
|
||||
|
||||
#### [0.1.0] - 2025-04-17
|
||||
#### Added
|
||||
- Initial release with basic template structure
|
||||
|
345
LICENSE
345
LICENSE
@ -1,7 +1,338 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
|
||||
<html><head>
|
||||
<title>302 Found</title>
|
||||
</head><body>
|
||||
<h1>Found</h1>
|
||||
<p>The document has moved <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">here</a>.</p>
|
||||
</body></html>
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
<https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Moe Ghoul>, 1 April 1989
|
||||
Moe Ghoul, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
||||
|
@ -134,6 +134,9 @@ This project is licensed under the GPL-2.0+ License - see the [LICENSE](LICENSE)
|
||||
|
||||
## Changelog
|
||||
|
||||
### 0.1.1
|
||||
- Updated LICENSE file with correct GPL-2.0 text
|
||||
|
||||
### 0.1.0
|
||||
- Initial release with basic template structure
|
||||
- Added core plugin architecture
|
||||
|
175
STARTER-PROMPT.md
Normal file
175
STARTER-PROMPT.md
Normal file
@ -0,0 +1,175 @@
|
||||
# WordPress Plugin Starter Template - AI Assistant Prompt
|
||||
|
||||
This document provides a comprehensive prompt to help you get started with creating your own WordPress plugin using this starter template with the assistance of AI tools like GitHub Copilot, Claude, or ChatGPT.
|
||||
|
||||
## Initial Setup Prompt
|
||||
|
||||
Use the following prompt to guide the AI assistant in helping you set up your new plugin based on this template:
|
||||
|
||||
```
|
||||
I'm creating a new WordPress plugin based on the wp-plugin-starter-template-for-ai-coding template. Please help me customize this template for my specific plugin needs.
|
||||
|
||||
Here are the details for my new plugin:
|
||||
|
||||
- Plugin Name: [YOUR PLUGIN NAME]
|
||||
- Plugin Slug: [YOUR-PLUGIN-SLUG]
|
||||
- Text Domain: [your-plugin-text-domain]
|
||||
- Namespace: [VENDOR]\[PluginName]
|
||||
- Description: [BRIEF DESCRIPTION OF YOUR PLUGIN]
|
||||
- Version: 0.1.0 (starting version)
|
||||
- Author: [YOUR NAME/ORGANIZATION]
|
||||
- Author URI: [YOUR WEBSITE]
|
||||
- License: GPL-2.0+ (or specify another compatible license)
|
||||
- Requires WordPress: [MINIMUM WP VERSION, e.g., 5.0]
|
||||
- Requires PHP: [MINIMUM PHP VERSION, e.g., 7.0]
|
||||
- GitHub Repository: [YOUR GITHUB REPO URL]
|
||||
- Gitea Repository (if applicable): [YOUR GITEA REPO URL]
|
||||
|
||||
I need help with the following tasks:
|
||||
|
||||
1. Updating all template placeholders with my plugin information
|
||||
2. Customizing the plugin structure for my specific needs
|
||||
3. Setting up the initial functionality for my plugin
|
||||
|
||||
Please guide me through this process step by step, starting with identifying all files that need to be updated with my plugin information.
|
||||
```
|
||||
|
||||
## Files That Need Updating
|
||||
|
||||
The AI will help you identify and update the following files with your plugin information:
|
||||
|
||||
1. **Main Plugin File**: Rename `wp-plugin-starter-template.php` to `your-plugin-slug.php` and update all plugin header information
|
||||
2. **README.md**: Update with your plugin details, features, and installation instructions
|
||||
3. **readme.txt**: Update WordPress.org plugin repository information
|
||||
4. **CHANGELOG.md**: Initialize with your starting version
|
||||
5. **composer.json**: Update package name and description
|
||||
6. **languages/pot file**: Rename and update the POT file
|
||||
7. **.github/workflows/**: Update GitHub Actions workflows with your repository information
|
||||
8. **.wiki/**: Update wiki documentation with your plugin information
|
||||
9. **.ai-assistant.md**: Update AI assistant guidance for your specific plugin
|
||||
10. **includes/plugin.php**: Update namespace and class references
|
||||
11. **includes/core.php**: Update namespace and customize core functionality
|
||||
12. **admin/lib/admin.php**: Update namespace and customize admin functionality
|
||||
|
||||
## Customization Process
|
||||
|
||||
After providing the initial information, follow this process with your AI assistant:
|
||||
|
||||
### 1. File Renaming
|
||||
|
||||
Ask the AI to help you identify all files that need to be renamed:
|
||||
|
||||
```
|
||||
Please list all files that need to be renamed to match my plugin slug, and provide the commands to rename them.
|
||||
```
|
||||
|
||||
### 2. Namespace Updates
|
||||
|
||||
Ask the AI to help you update all namespace references:
|
||||
|
||||
```
|
||||
Please help me update all namespace references from WPALLSTARS\PluginStarterTemplate to [VENDOR]\[PluginName] throughout the codebase.
|
||||
```
|
||||
|
||||
### 3. Text Domain Updates
|
||||
|
||||
Ask the AI to help you update all text domain references:
|
||||
|
||||
```
|
||||
Please help me update all text domain references from 'wp-plugin-starter-template' to '[your-plugin-text-domain]' throughout the codebase.
|
||||
```
|
||||
|
||||
### 4. Function Prefix Updates
|
||||
|
||||
Ask the AI to help you update any function prefixes:
|
||||
|
||||
```
|
||||
Please help me update any function prefixes from 'wpst_' to '[your_prefix]_' throughout the codebase.
|
||||
```
|
||||
|
||||
### 5. Customizing Core Functionality
|
||||
|
||||
Ask the AI to help you customize the core functionality for your specific plugin needs:
|
||||
|
||||
```
|
||||
Now I'd like to customize the core functionality for my plugin. Here's what my plugin should do:
|
||||
|
||||
[DESCRIBE YOUR PLUGIN'S CORE FUNCTIONALITY]
|
||||
|
||||
Please help me modify the includes/core.php file to implement this functionality.
|
||||
```
|
||||
|
||||
### 6. Customizing Admin Interface
|
||||
|
||||
Ask the AI to help you customize the admin interface for your specific plugin needs:
|
||||
|
||||
```
|
||||
I'd like to customize the admin interface for my plugin. Here's what I need in the admin area:
|
||||
|
||||
[DESCRIBE YOUR PLUGIN'S ADMIN INTERFACE NEEDS]
|
||||
|
||||
Please help me modify the admin/lib/admin.php file and any other necessary files to implement this.
|
||||
```
|
||||
|
||||
### 7. Testing Setup
|
||||
|
||||
Ask the AI to help you set up testing for your plugin:
|
||||
|
||||
```
|
||||
Please help me update the testing setup to match my plugin's namespace and functionality. I want to ensure I have proper test coverage for the core features.
|
||||
```
|
||||
|
||||
## Additional Customization Areas
|
||||
|
||||
Depending on your plugin's needs, you might want to ask the AI for help with:
|
||||
|
||||
1. **Custom Post Types**: Setting up custom post types and taxonomies
|
||||
2. **Settings API**: Implementing WordPress Settings API for your plugin options
|
||||
3. **Shortcodes**: Creating shortcodes for front-end functionality
|
||||
4. **Widgets**: Developing WordPress widgets
|
||||
5. **REST API**: Adding custom REST API endpoints
|
||||
6. **Blocks**: Creating Gutenberg blocks
|
||||
7. **Internationalization**: Ensuring proper i18n setup
|
||||
8. **Database Tables**: Creating custom database tables if needed
|
||||
9. **Cron Jobs**: Setting up WordPress cron jobs
|
||||
10. **User Roles and Capabilities**: Managing custom user roles and capabilities
|
||||
|
||||
## Final Review
|
||||
|
||||
Once you've completed the customization, ask the AI to help you review everything:
|
||||
|
||||
```
|
||||
Please help me review all the changes we've made to ensure:
|
||||
|
||||
1. All template placeholders have been replaced with my plugin information
|
||||
2. All namespaces, text domains, and function prefixes have been updated consistently
|
||||
3. The plugin structure matches my specific needs
|
||||
4. The initial functionality is properly implemented
|
||||
5. All documentation (README.md, readme.txt, wiki) is updated and consistent
|
||||
|
||||
Are there any issues or inconsistencies that need to be addressed?
|
||||
```
|
||||
|
||||
## Building and Testing
|
||||
|
||||
Finally, ask the AI to guide you through building and testing your plugin:
|
||||
|
||||
```
|
||||
Please guide me through the process of building and testing my plugin:
|
||||
|
||||
1. How do I use the build script to create a deployable version?
|
||||
2. What tests should I run to ensure everything is working correctly?
|
||||
3. How do I set up a local testing environment?
|
||||
4. What should I check before releasing the first version?
|
||||
```
|
||||
|
||||
## Remember
|
||||
|
||||
- This template is designed to be a starting point. Feel free to add, remove, or modify components as needed for your specific plugin.
|
||||
- The AI assistant can help you understand the existing code and make appropriate modifications, but you should review all changes to ensure they meet your requirements.
|
||||
- Always test your plugin thoroughly before releasing it.
|
||||
- Keep documentation updated as you develop your plugin.
|
||||
|
||||
## Credits
|
||||
|
||||
This plugin is based on the [WordPress Plugin Starter Template for AI Coding](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding) by WPALLSTARS.
|
@ -2,14 +2,14 @@
|
||||
# This file is distributed under the GPL-2.0+.
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: WordPress Plugin Starter Template 0.1.0\n"
|
||||
"Project-Id-Version: WordPress Plugin Starter Template 0.1.1\n"
|
||||
"Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/wp-plugin-starter-template\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"POT-Creation-Date: 2025-04-17T00:00:00+00:00\n"
|
||||
"POT-Creation-Date: 2025-04-18T00:00:00+00:00\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"X-Generator: WP-CLI 2.9.0\n"
|
||||
"X-Domain: wp-plugin-starter-template\n"
|
||||
|
@ -5,7 +5,7 @@ Tags: starter, template, boilerplate, plugin development, ai coding
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.4
|
||||
Requires PHP: 7.0
|
||||
Stable tag: 0.1.0
|
||||
Stable tag: 0.1.1
|
||||
License: GPL-2.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
@ -76,6 +76,9 @@ Contributions are welcome! Please feel free to submit a pull request or open an
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 0.1.1 =
|
||||
* Updated LICENSE file with correct GPL-2.0 text
|
||||
|
||||
= 0.1.0 =
|
||||
* Initial release with basic template structure
|
||||
* Added core plugin architecture
|
||||
|
38
wp-plugin-starter-template.php
Normal file
38
wp-plugin-starter-template.php
Normal file
@ -0,0 +1,38 @@
|
||||
<?php
|
||||
/**
|
||||
* Plugin Name: WordPress Plugin Starter Template
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.
|
||||
* Version: 0.1.1
|
||||
* Author: Your Name & The WPALLSTARS Team
|
||||
* Author URI: https://www.wpallstars.com
|
||||
* License: GPL-2.0+
|
||||
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
|
||||
* Text Domain: wp-plugin-starter-template
|
||||
* Domain Path: /languages
|
||||
* GitHub Plugin URI: wpallstars/wp-plugin-starter-template-for-ai-coding
|
||||
* GitHub Branch: main
|
||||
* Primary Branch: main
|
||||
* Release Branch: main
|
||||
* Release Asset: true
|
||||
* Requires at least: 5.0
|
||||
* Requires PHP: 7.0
|
||||
* Update URI: https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding
|
||||
*
|
||||
* Gitea Plugin URI: https://gitea.wpallstars.com/wpallstars/wp-plugin-starter-template-for-ai-coding
|
||||
* Gitea Branch: main
|
||||
* Gitea Languages: languages
|
||||
*
|
||||
* @package WPALLSTARS\PluginStarterTemplate
|
||||
*/
|
||||
|
||||
// If this file is called directly, abort.
|
||||
if (!defined('WPINC')) {
|
||||
die;
|
||||
}
|
||||
|
||||
// Load the main plugin class
|
||||
require_once plugin_dir_path(__FILE__) . 'includes/plugin.php';
|
||||
|
||||
// Initialize the plugin
|
||||
new WPALLSTARS\PluginStarterTemplate\Plugin(__FILE__, '0.1.1');
|
Reference in New Issue
Block a user