Skip to content
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

Profile org page and contribution files. #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
83 changes: 83 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# 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. WordPress 6.2 or later installed locally
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. WordPress 6.2 or later installed locally
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we need to update before build?

Suggested change
composer build
composer update
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)
- Run code quality checks before submitting:

```bash
composer cs # Check coding standards
composer stan # Static analysis
composer test # Run PHPUnit tests
```

## 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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be add optional plugins version (i.e. for compatibility).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
See a670fed

- Specify third party names and versions if applicable
- Include relevant error messages and screenshots

## Documentation

- Keep inline documentation up to date
- Follow PHPDoc standards for new code
Comment on lines +72 to +75
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this (at the same level) before or after Coding standards.


## Questions?

- For general purpose questions, feel free to contact us at our [helpdesk](https://polylang.pro/support/) (premium support only).
Comment on lines +77 to +79
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this section (Pandora's box).


## License

By contributing to Polylang, you agree that your contributions will be licensed under the GPL-3.0 License.
Comment on lines +81 to +83
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this (at the same level) below Coding standards.

21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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*
7 changes: 7 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -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).
4 changes: 4 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Support

GitHub issues are meant for enhancement requests and specific, reproducible bugs, not for general support questions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe provide a link to the community support forum on wp.org

We provide a premium support through our paid plugins, please visit our [website](https://polylang.pro/support/).
Binary file added assets/banner-772x250.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
128 changes: 128 additions & 0 deletions assets/polylang-logo.svg
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure we need this file as we re-use https://avatars.githubusercontent.com/u/18660148

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Welcome to Polylang 👋

![Polylang Logo](../assets/banner-772x250.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this.


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
- **Polylang Pro**: Advanced features for professional websites
- **Polylang for WooCommerce**: Complete solution for multilingual e-commerce
Comment on lines +11 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add links?


## 📦 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 before submitting your pull request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add link?


## 📊 Stats

- 700,000+ Active Installations
- Available in 50+ Languages
- Trusted by businesses worldwide
- 4.5-star ratings from satisfied users
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 4.5-star ratings from satisfied users
- 4.7-star ratings from satisfied users

- A small team of 8 people from France

---

<sub>Polylang - Making WordPress Multilingual</sub>