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
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ All parameters, return values, and properties should use explicit type hints whe

The following naming conventions must be followed for consistency and autoloading:

- Interfaces are suffixed with `_Interface` (e.g., `Feature_Interface`).
- Interfaces are suffixed with `_Interface` (e.g., `Experiment_Interface`).
- Traits are suffixed with `_Trait` (e.g., `Validation_Trait`).
- File names are the same as the class, trait, and interface name for PSR-4 autoloading.
- Classes use WordPress naming conventions with underscores (e.g., `Feature_Loader`).
- Classes use WordPress naming conventions with underscores (e.g., `Experiment_Loader`).
- Namespaces follow the pattern `WordPress\AI\{Component}`.

## Documentation standards
Expand Down Expand Up @@ -43,20 +43,20 @@ All code must be properly documented with PHPDoc blocks following these standard

```php
/**
* Class for handling feature registration.
* Class for handling experiment registration.
*
* @since 0.1.0
*/
class Feature_Registry {
class Experiment_Registry {
/**
* Registers a new feature with the plugin.
* Registers a new experiment with the plugin.
*
* @since 0.1.0
*
* @param Feature $feature The feature instance to register.
* @param Experiment $experiment The experiment instance to register.
* @return bool True if registered successfully, false otherwise.
*/
public function register_feature( Feature $feature ): bool {
public function register_experiment( Experiment $experiment ): bool {
// Implementation
}
}
Expand Down Expand Up @@ -137,8 +137,8 @@ echo 'Hello World';

## Additional resources

For more detailed information on plugin architecture, creating features, and development workflows, see:
For more detailed information on plugin architecture, creating experiments, and development workflows, see:

- [Developer Guide](docs/DEVELOPER_GUIDE.md) - Comprehensive guide to plugin architecture and feature development
- [Developer Guide](docs/DEVELOPER_GUIDE.md) - Comprehensive guide to plugin architecture and experiment development
- [Testing Strategy](docs/TESTING.md) - Testing philosophy and guidelines
- [WordPress AI Team](https://make.wordpress.org/ai/) - Community and discussion
Loading
Loading