Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 5.6 KB

CONTRIBUTING.md

File metadata and controls

82 lines (49 loc) · 5.6 KB
Raw

Contributing to Everest Forms ✨

There are many ways to contribute to the Everest Forms project!

  • Translating strings into your language.
  • Answering questions on GitHub and within the various Everest Forms communities.
  • Submitting fixes, improvements, and enhancements.

Your help making Everest Forms even more awesome will be greatly appreciated :)

If you think something can be improved and you wish to contribute code, fork Everest Forms, commit your changes, and send a pull request. We'll be happy to review your changes!

Feature Requests

Feature requests can be submitted to our issue tracker. Be sure to include a description of the expected behavior and use case, and before submitting a request, please search for similar ones in the closed issues.

Feature request issues will remain closed until we see sufficient interest via comments and 👍 reactions from the community.

You can see a list of current feature requests which require votes here.

Technical Support / Questions

We don't offer technical support on GitHub so we recommend using the following:

Reading our documentation Usage docs can be found here: https://docs.wpeverest.com/docs/everest-forms/

If you have a problem, you may want to start with the self help guide here: https://docs.wpeverest.com/docs/everest-forms/self-service-guide/

Technical support for premium addons or if you're a WPEverest.com customer from a human being - submit a ticket via the helpdesk https://wpeverest.com/contact/

General usage and development questions

Code of conduct

Everest Forms has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Coding Guidelines

  • Ensure you stick to the WordPress Coding Standards
  • Install our pre-commit hook using composer. It'll help with the Coding Standards. To install run composer install from the command line within the everest-forms plugin directory.
  • Ensure you use LF line endings in your code editor. Use EditorConfig if your editor supports it so that indentation, line endings and other settings are auto configured.
  • When committing, reference your issue number (#1234) and include a note about the fix.
  • Ensure that your code is compatible with PHP 5.4+.
  • Push the changes to your fork and submit a pull request on the master branch of the Everest Forms repository. Existing maintenance branches will be maintained by Everest Forms developers.

Please don't modify the changelog or update the .pot files. These will be maintained by the Everest Forms team.

Translating Everest Forms

We have a project on translate.wordpress.org. You can join the localization team of your language and help by translating Everest Forms. Find more about using joining a language team and using GlotPress.

If Everest Forms is already 100% translated for your language, join the team anyway! We regularly update our language files and there will definitely be need of your help soon.

Glossary & Style Guide

Please refer to this page on the Translator Handbook for information about the glossary and the style guide.

We maintain the Everest Forms glossary on this shared Google Sheet. You can use it as a template for creating your own glossary. Please download the file by going to File > Download as > Comma-separated values (.csv, current sheet) and save it on your computer/Mac. Open it with your favourite CSV editor (or re-upload it on your own Google Drive) and edit it.

Make sure to edit the second column’s header by using your own language’s code (eg. for Italian you would use it, for Portuguese (Brazil) you would use pt-BR).

Write the translated entry in this column and translate the entry description as well. Don’t change other columns headers and value, but feel free to add new entries.

When your CSV is ready, import it on GlotPress.

Warning: Importing a CSV does not replace existing items, they will be created again. We suggest to import them only when first creating the glossary.

Each translation editor will take care of updating the glossary on GlotPress by editing/adding items when needed.

Note: Only editors can create/import and edit glossaries and glossary items on GlotPress. Anyone can suggest new items to add to the glossary or translate them.

Style Guides Available

We don’t have a Style Guide template available, so feel free to create your own. If you created a style guide for your language, please let us know so we can add it in the list above. You can also add it by yourself by submitting a PR for this file.