74 lines
4.7 KiB
Markdown
74 lines
4.7 KiB
Markdown
# Contribution Guidelines
|
|
<img src="https://i.imgur.com/9Q1FFKP.png" alt="Elementor logo" width="250px">
|
|
|
|
Before filing a bug report or a feature request, be sure to read the contribution guidelines.
|
|
|
|
## How to use GitHub
|
|
We use GitHub exclusively for well-documented bugs, feature requests and code contributions. Communication is always done in English.
|
|
|
|
## Got a Question or Problem?
|
|
|
|
Please **DO NOT** open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on one of the proper support channels:
|
|
|
|
To receive free support for Elementor we have the following channels:
|
|
* [Elementor Community](https://www.facebook.com/groups/Elementors/) on Facebook
|
|
* [Elementor Knowledge base](https://docs.elementor.com)
|
|
* [Support forums](https://wordpress.org/support/plugin/elementor) on WordPress.org
|
|
|
|
If you have purchased [Elementor Pro](https://elementor.com/pro), you are entitled for personal support, please see your purchase email for details.
|
|
|
|
*To save your and our time, we will systematically close all issues that are requests for general support.*
|
|
|
|
Thanks for your understanding.
|
|
|
|
## Security Issues
|
|
Please do not report security issues here. Instead, email them to support at elementor dot com so we can deal with them securely and quickly.
|
|
|
|
## Found a Bug?
|
|
If you find a bug in the source code, you can help us by [submitting a bug report](#bug-report) issue to our [GitHub Repository](https://github.com/elementor/elementor/issues/new?template=Feature_request.md). Even better, you can submit a Pull Request with a fix.
|
|
|
|
### Bug Report
|
|
Before opening a new issue, please:
|
|
* update to the newest versions of WordPress and the Elementor/Elementor Pro plugins.
|
|
* search for duplicate issues to prevent opening a duplicate issue. If there is already an open existing issue, please comment on that issue.
|
|
* check our [Elementor Knowledge base](https://docs.elementor.com) for your issue. There are a lot of common errors documented there with possible solutions.
|
|
* follow our [Bug Report](https://github.com/elementor/elementor/issues/new?template=Bug_report.md) template when creating a new issue.
|
|
* add as much information as possible. For example: add screenshots, relevant links, step by step guides etc.
|
|
|
|
## Feature Request
|
|
Before opening a new Feature Request issue, please:
|
|
* Search for duplicate issues to prevent opening a duplicate feature request. If there is already an open existing request, please leave a comment there.
|
|
* Follow our [Feature Request](https://github.com/elementor/elementor/issues/new?template=Feature_request.md) template when creating a new issue.
|
|
* Add as much information as possible. For example: give us a clear explanation of why you think the feature request is something we should consider for Elementor.
|
|
|
|
## I want to Contribute
|
|
Community contributions are always welcome and help us remain the **Number 1 WordPress Page Builder**.
|
|
|
|
There are many ways to contribute to Elementor:
|
|
- Translating strings into your language.
|
|
- Answering questions on GitHub and within the various Elementor communities.
|
|
- Submitting fixes, improvements, and enhancements.
|
|
|
|
When contributing please ensure you follow the guidelines below so that we can keep on top of things.
|
|
|
|
#### Before Submitting a PR
|
|
Make sure your problem does not exist as an issue already by searching through [the existing issues](https://github.com/elementor/elementor/issues). If you cannot find anything which relates to your problem, please [create a new issue](https://github.com/elementor/elementor/issues/new).
|
|
|
|
#### Submitting a PR
|
|
|
|
* Fork the repository on GitHub (make sure to use the next minor version branch, not master).
|
|
* Make the changes to your forked repository.
|
|
* Ensure you stick to the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/) and you properly document any new functions, actions and filters following the [documentation standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/).
|
|
* When committing, reference your issue and include a note about the fix.
|
|
* Push the changes to your fork and submit a pull request to the master branch of the Elementor repository.
|
|
* make sure you follow the Pull Request Template.
|
|
|
|
|
|
We will review your pull request and merge when everything is in order. We will help you to make sure the code complies with the standards described above.
|
|
|
|
#### Additional Resources
|
|
* [Elementor API Documentation](https://developers.elementor.com)
|
|
* [Elementor Code reference](https://code.elementor.com)
|
|
* [General GitHub Documentation](https://help.github.com/)
|
|
* [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)
|