# AutoMeta AI - Contributing Guide

Thank you for considering to contribute to AutoMeta AI! This document provides guidelines and instructions for contributing.

## Code of Conduct

- Be respectful to all contributors
- Follow WordPress coding standards
- Test your changes thoroughly before submitting

## Getting Started

1. Fork the repository
2. Clone your fork: `git clone https://github.com/yourname/auraseo.git`
3. Create a new branch: `git checkout -b feature/your-feature-name`
4. Make your changes
5. Commit with clear messages: `git commit -m "Add feature description"`
6. Push to your fork: `git push origin feature/your-feature-name`
7. Submit a Pull Request

## Code Standards

### PHP Code Standards
- Follow [WordPress PHP Coding Standards](https://developer.wordpress.org/plugins/php/wordpress-coding-standards/)
- Use proper PHPDoc comments for functions
- Always sanitize and escape user input
- Use prepared statements for database queries

### JavaScript Standards
- Use jQuery consistently (as used in the plugin)
- Add JSDoc comments for functions
- Follow ESLint configuration if available
- Test AJAX requests thoroughly

### CSS Standards
- Use CSS custom properties (variables) where possible
- Maintain mobile-responsive design
- Follow BEM naming convention
- Group related styles together

## Testing

Before submitting a PR:
1. Test in WordPress 5.6+ environments
2. Test with both Yoast SEO and Rank Math
3. Test CSV import with various data formats
4. Test API connections with both providers
5. Check for JavaScript console errors
6. Verify security nonce tokens are working

## File Structure

```
auraseo/
├── assets/
│   ├── css/
│   │   └── style.css
│   └── js/
│       └── script.js
├── languages/        (i18n support)
├── docs/             (Documentation)
├── src/              (Future: Core classes)
├── LICENSE
├── INSTALLATION.md
├── CONTRIBUTING.md
├── readme.txt
└── auraseo.php   (Main plugin file)
```

## Areas for Contribution

- **Translations:** Help translate the plugin to new languages
- **Documentation:** Improve guides and tutorials
- **Features:** Suggest or implement new features
- **Bug Fixes:** Report and fix issues
- **Testing:** Help test and report bugs

## Reporting Bugs

1. Check if the bug has already been reported
2. Include clear steps to reproduce
3. Provide screenshots if applicable
4. List your environment (WP version, PHP version, plugins)

## Suggesting Features

1. Check if the feature has been suggested
2. Explain the use case clearly
3. Provide examples if possible
4. Discuss implementation approach

## License

By contributing, you agree that your contributions will be licensed under the GPLv2 or later license.

