diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..63b5070 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,76 @@ +# Contributing to Polylang + +Thank you for your interest in contributing to Polylang! This document provides guidelines and information for contributors. + +## Getting Started + +### Prerequisites + +Before you begin, ensure you have: + +1. The latest version of WordPress installed locally +2. Git +3. Node.js (LTS version recommended) +4. Composer + +### Development Setup + +1. Fork the repository on GitHub +2. Clone your fork locally: + +```bash + cd wp-content/plugins + git clone https://github.com/YOUR-USERNAME/polylang.git + cd polylang + ``` + +3. Set up development dependencies: + +```bash +composer build +``` + +## Development Workflow + +1. Create a new branch for your feature or fix: + +```bash +git checkout -b feature/your-feature-name +``` + +2. Make your changes following our coding standards +3. Test your changes thoroughly +4. Commit your changes with clear, descriptive messages +5. Push to your fork and submit a pull request + +### Coding Standards + +- Follow WordPress Coding Standards +- Use PHP CodeSniffer and ESLint (included in dev dependencies) +- Keep inline documentation up to date +- Follow PHPDoc standards for new code +- Run code quality checks before submitting: + +```bash +composer cs # Check coding standards +composer stan # Static analysis +composer test # Run PHPUnit tests +``` + +## License + +By contributing to Polylang, you agree that your contributions will be licensed under the GPL-3.0 License. + +## Pull Request Guidelines + +1. Provide a clear and concise description +2. Link any related issues in your pull request description +3. Ensure all tests pass + +## Reporting Issues + +- Use the issue template when creating new issues +- Include detailed steps to reproduce bugs +- Specify your WordPress and Polylang versions +- Specify third party names and versions if applicable +- Include relevant error messages and screenshots diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7aa5a77 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +Thank you for your contribution! + +Before submitting, please ensure: + +- [ ] You've read our [contributing guidelines](./CONTRIBUTING.md) +- [ ] No duplicate pull request exists for this issue +- [ ] You've linked any related issues +- [ ] Your code adheres to our coding standards +- [ ] All tests are passing + +## What? + +*Link any related issues or describe what your changes address* + +## Why? + +*Explain the motivation behind these changes* + +## How? + +*If complex, describe how you implemented the changes* diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..a675eff --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,7 @@ +# Reporting Security Issues + +Thanks for wanting to help keep Polylang plugins and add-ons secure! + +Our team takes security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. + +To report a security issue, please visit our [support page](https://polylang.pro/support/) (you may choose "other" as subject of your request). diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..7952a86 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,5 @@ +# Support + +GitHub issues are meant for enhancement requests and specific, reproductible bugs, not for general support questions. +Community support is available on WordPress [forum](https://wordpress.org/support/plugin/polylang/). +Also, we provide premium support through our paid plugins, please visit our [website](https://polylang.pro/support/). diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..a276306 --- /dev/null +++ b/profile/README.md @@ -0,0 +1,50 @@ +# Welcome to Polylang 👋 + +Polylang is a powerful WordPress plugin that makes building multilingual websites easy and intuitive. With over 700,000 active installations, we're helping websites around the world connect with their global audience. + +## 🌍 About Us + +We believe in making multilingual WordPress sites accessible to everyone. Our solutions include: + +- **Polylang**: Our free WordPress plugin for basic multilingual needs, [see](https://polylang.pro/downloads/polylang/). +- **Polylang Pro**: Advanced features for professional websites, [see](https://polylang.pro/downloads/polylang-pro/). +- **Polylang for WooCommerce**: Complete solution for multilingual e-commerce, [see](https://polylang.pro/downloads/polylang-for-woocommerce/). + +## 📦 Our Main Repositories + +- [**polylang**](https://github.com/polylang/polylang) - Our flagship WordPress multilingual plugin +- [**polylang-stubs**](https://github.com/polylang/polylang-stubs) - PHP stubs for Polylang and Polyland add-ons development +- [**polylang-phpstan**](https://github.com/polylang/polylang-phpstan) - PHPStan integration for Polylang +- [**wpml-to-polylang**](https://github.com/polylang/wpml-to-polylang) - Migration tool from WPML to Polylang, also found on the WordPress repo ([see](https://wordpress.org/plugins/wpml-to-polylang/)) +- [**FSE Classic Features**](https://github.com/polylang/fse-classic) - Use legacy widgets and menus in the site editor, also found on the WordPress repo ([see](https://wordpress.org/plugins/fse-classic/)) + +## 🔗 Useful Links + +- [Official Website](https://polylang.pro) +- [Documentation](https://polylang.pro/doc/) +- [Support Forum](https://wordpress.org/support/plugin/polylang/) +- [Pro Support](https://polylang.pro/support/) + +## 💡 Contributing + +We welcome contributions from the community! Whether it's: + +- 🐛 Bug reports +- 💬 Feature suggestions +- 📖 Documentation improvements +- 🔧 Code contributions + +Please check our contribution [guidelines](../.github/CONTRIBUTING.md) before submitting your pull request. + +## 📊 Stats + +- 700,000+ Active Installations +- Available in 50+ Languages +- Trusted by businesses worldwide +- 4.7-star ratings from satisfied users +- A small team of 8 people from France + +--- + +Polylang - Making WordPress Multilingual +