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 5 commits into
base: main
Choose a base branch
from

Conversation

Hug0-Drelon
Copy link
Member

What?

Add a profile readme for Polylang organization.
Create contribution health file for the whole organization, including:

  • contributing guidelines
  • security policy
  • support guidelines
  • pull request template

@Hug0-Drelon Hug0-Drelon self-assigned this Nov 21, 2024

- 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

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
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

Copy link
Member Author

Choose a reason for hiding this comment

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

Comment on lines 72 to 75
## Documentation

- Keep inline documentation up to date
- Follow PHPDoc standards for new code
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.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 58d532e.

Comment on lines 81 to 83
## License

By contributing to Polylang, you agree that your contributions will be licensed under the GPL-3.0 License.
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.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 58d532e.

Comment on lines 77 to 79
## Questions?

- For general purpose questions, feel free to contact us at our [helpdesk](https://polylang.pro/support/) (premium support only).
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).

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 58d532e.

- 📖 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?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 58d532e.

profile/README.md Outdated Show resolved Hide resolved
Comment on lines 11 to 13
- **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
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?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 58d532e.

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

Copy link
Member Author

Choose a reason for hiding this comment

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

My bad, I forgot to remove it.

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 58d532e.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants