Skip to content

Latest commit

 

History

History
132 lines (83 loc) · 11.2 KB

CONTRIBUTING.md

File metadata and controls

132 lines (83 loc) · 11.2 KB

Contribution Guidelines

logo

Welcome to the Elementor Contribution Guidelines

Community contributions are always welcomed and help us remain the Number 1 WordPress Website Builder. Contributors can answer questions on all Elementor GitHub spaces or submit their contributions in the appropriate channels.

Before submitting contributions, all participants should read and follow these Guidelines and our Code of Conduct.

How to use GitHub

We use GitHub exclusively for well-documented Bug Reports, Feature Requests and Code Contributions (Pull Requests).
Communication should always be in English.

Need Help, Guidance, Assistance, or Support?

Note that we are unable to offer any support through this repository.

Please DO NOT open issues or discussions to request support.
For those, use the appropriate channels.

Find out how to submit a Support Ticket here.

Alternatively, you can visit one of these resources:

  • Help Center
    Visit the Elementor Help Center to find solutions to the most frequent problems, or read the documentation about Elementor's many features.
  • Academy
    Grow your Web Creator skills and learn to make the most of Elementor in the Elementor Academy.
  • Global Community
    Join the Elementor Global Community on Facebook. Where all kinds of users come together to help each other.
  • Support Forum
    If you have more questions, visit the free Support Forum on our WordPress plugin page.
  • Elementor Website
    For more information about features, FAQs, and documentation, check out our website at Elementor Website Builder.

If you have an active Elementor Pro subscription, you are entitled to personal support. Please see your purchase email or visit your Elementor Account page for details.

As a gentle reminder, we may close support requests submitted to GitHub spaces without action.

How to report Security Issues

Security is paramount at Elementor. If you discover a security vulnerability, we want to hear about it right away, and we appreciate your help in disclosing it to us in a coordinated manner. For this reason, we run community-driven Managed Security Bug Bounty programs.

We leverage the collective expertise of our community, offering round-the-clock crowdsourced vulnerability detection. These programs provide a comprehensive overview of features and endpoints considered 'in scope,' reward specifics where relevant, and our complete terms and conditions.

Please do not report security issues on GitHub

Join our Managed Security Bug Bounty programs instead and help us maintain Elementor, a secure software, responsibly.

To learn more about our security efforts and how to contact us for security inquiries, please visit our Trust Center.

How to Report a Bug

If you found a bug in the source code and can reproduce it consistently after troubleshooting it, you can help us by submitting a Bug Report.

Before submitting your Bug Report, follow these best practices to help save time

  • Search Before Posting
    Please search for similar issues (both open and closed) to prevent creating duplicates.
    Use GitHub Labels to refine your search.
  • Stay Up-to-date
    Ensure you are using the most recent and stable versions of Elementor (and Elementor Pro), as well as all installed plugins, themes, and WordPress.
  • Troubleshoot your Issue
    Visit our Help Center and use the search function to find troubleshooting articles for the most common problems that can be solved quickly.
  • Isolate the Problem and Validate your Issue
    Ensure your issue happens when only the Elementor (and Elementor Pro) plugins are active while also using the Hello Elementor theme.
    Isolating the problem helps identify if Elementor causes the issue you're experiencing
  • Write a Clear and Concise Title
    Summarize your title in a short sentence that can help identify your issue at a glance without needing to read the description.
  • Provide a Detailed Description
    Please help us understand in detail what problems you are experiencing.
    Give a detailed description of your problem, and provide examples, screenshots, screen recordings, and related links.
  • Explain how we can Recreate your Issue
    Enumerate all the steps needed to reproduce the issue in detail so we can replicate it in our environment.
  • Tell us what you were Expecting to Happen
    Describe the Expected Behavior to help identify the root of the issue.
  • Share the Elementor System Info
    Be ready to share a full copy of the Elementor System Info report from your WordPress Dashboard > Elementor > System Info page (available at the bottom of the page).
    We won't accept issues without it. Learn how to copy it here.
  • Write One Bug Report per Issue
    If you are experiencing more than one bug, submit only ONE BUG PER ISSUE.

As a gentle reminder, we may close issues that do not comply with these guidelines without action.

How to Request a Feature

Do you have a brilliant idea, enhancement, or feature you would love to see in Elementor? We're all ears!

Suggest new ideas, features, or enhancements by submitting a Feature Request.
You can also support existing ideas by voting for your favorite requests.

Before submitting a new Feature Request, follow these best practices to help save time

  • Search Before Posting
    Before creating a new Feature Request, please search for similar requests to prevent creating duplicates.
  • Confirm Before Posting
    Please check the Elementor Features page before posting to avoid requesting an existing feature.
  • Write a Clear and Concise Title
    Summarize your title in a short sentence that can help identify your request at a glance without needing to read the description.
  • Provide a Detailed Description
    Elaborate on how you envision the feature. Include examples, use cases, and any other relevant details.
  • Describe the Solution
    Describe how you'd like a solution to be implemented.
  • Provide Alternatives
    Mention any alternative solutions or workarounds you've considered.
  • Give Additional Context
    Add context to your suggestion by providing examples, screenshots, screen recordings, related links, and additional information that might help us understand your request better.
  • Write One Request Per Thread
    If you have multiple requests, please submit only ONE REQUEST PER THREAD.

As a gentle reminder, we may close requests that do not comply with these guidelines without action.

I want to Contribute

Community contributions are always welcome! We're glad to hear you are interested in helping shape the future of Elementor.

There are many ways to contribute to Elementor

Translate

The Elementor User Interface was designed with a global audience in mind. It supports a wide range of languages and is also RTL compatible. Out of the box, we offer support for over 60 languages.

Want to make a difference?
We would appreciate your contribution by adding a new language or helping translate existing ones at translate.wordpress.org. To assist you, we've built a short guide explaining how to translate and localize the plugin.

Community Support

Join others by answering questions on Elementor's GitHub spaces to help solve issues and engage in discussions.
Your insights and solutions can greatly assist others in navigating similar challenges.

Submit Pull Requests

If you can submit fixes, improvements, or enhancements through pull requests, that's fantastic! We'd love your technical contributions. Please refer to our detailed guide on submitting pull requests below for more information.

Before Submitting a PR

Submitting a PR

  • Fork the Repository
    Start by forking the Elementor repository on GitHub. Please ensure you're using the main branch.
  • Create a new branch
    Create a new branch exclusive to the changes you're going to perform. This way, you can maintain separation between projects.
  • Make your changes
    After you've forked the repository, you can start changing your copy of the code.
  • Adhere to Coding Standards
    While making changes, ensure you stick to the WordPress Coding Standards.
    If you've added new functions, actions, or filters, please document them properly following the WordPress PHP Documentation Standards.
  • Commit with a Reference and Note
    When you commit your changes, reference your issue and include a note about your fix.
  • Submit a Pull Request
    After pushing the changes to your fork, you're ready to submit a pull request to the main branch of the Elementor repository. Please follow our Pull Request Template when submitting your PR.

Our team will review your pull request and, if approved and everything is in order, merge it into the main branch. We are here to assist you in making sure your code aligns with the standards described above.

Your contributions, big or small, play a significant part in the continued development of Elementor. We can't wait to see what you have to share!

Additional Resources