Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 4.07 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 4.07 KB
Raw

Thanks for reading our contribution guidelines! What do you want to do:

#Filing issues

Please Note: GitHub is for bug reports and code contributions only - if you have a support question or a request for a customisation don't post here, go to our Support Forum instead.

How to write a useful bug report

If you think you have found a bug (we acknowledge that that's a possibility), please make sure you're using the latest version of the plugin. If possible check out the latest version from GitHub and see if the bug still exists there.

A useful bug report explains:

  1. What you were trying to achieve.
  2. What you were expecting to happen.
  3. What actually happened, illustrated with screenshots if possible.

Your bug report should also contain your TYPO3 version and if there are any errors, the exact error text, including line numbers.

Blank / white screen

If you're getting a blank screen and you report just that, we can do absolutely nothing. By default, your TYPO3 install suppresses all errors, to prevent information leaks, but we need those errors to be able to help you. You can find those errors in your PHP errorlog. You can ask your webhosting-partner to get those logs.

That error will help us, without that error, we're completely in the dark about your white page problem...

Interface errors

If you're reporting a bug about specific interface elements not working as expected, there's probably an error showing in your browsers JavaScript console. Please open your browsers console and copy the exact error showing there, or make a screenshot. If you don't know how to open your browsers console, here is info for Chrome and Firefox. For IE, some Googling will help but it changes with every version.

#Security issues Please do not report security issues here, but email them to support at maxserv dot com so we can deal with them securely and quickly.

#Contribute to Yoast SEO for TYPO3

Community made patches, localisations, bug reports and contributions are very welcome and help make Yoast SEO for TYPO3 the #1 SEO plugin for TYPO3.

When contributing please ensure you follow the guidelines below so that we can keep on top of things.

Getting Started

If there is no ticket for your issue, submit it first, following the above guidelines.

Making Changes

  • Fork the repository on GitHub.
  • Make the changes to your forked repository.
  • When committing, reference your issue (if present) and include a note about the fix.
  • Push the changes to your fork and submit a pull request to the 'master' branch of the Yoast SEO for TYPO3 repository.

At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.

"Patch welcome" issues

Some issues are labeled "Patch-welcome". This means we see the value in the particular enhancement being suggested but have decided for now not to prioritize it. If you however decide to write a patch for it we'll gladly include it after some code review.

Releasing a new version of the extension

To release a new version of the extension, you should follow these steps:

  1. Make sure the CHANGELOG.md is updated
  2. Make sure the new version is updated in ext_emconf.php
  3. All latest code should be in the master branch
  4. Create a new release and use the syntax x.y.z for the title of the release as well as the title of the tag.
  5. A GitHub action Publish new version to TER should be triggered and will make sure the new version is released to TER
  6. Check for the new version on https://packagist.org/packages/yoast-seo-for-typo3/yoast_seo

Additional Resources