Make WordPress Core

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#47126 closed enhancement (wontfix)

Code Editor: default to readme.txt

Reported by: joyously's profile joyously Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: Editor Keywords:
Focuses: Cc:


Since the code editor is not the safest place for the user to be, perhaps the default file that is shown should be the readme.txt instead of style.css or the main plugin file. The current ones could be the fallback if there is no readme file.

Change History (4)

This ticket was mentioned in Slack in #core by joyously. View the logs.

5 years ago

#2 @desrosj
5 years ago

  • Keywords 2nd-opinion close added

I don't know that I see any benefits to making this change.

Can you identify any other benefits to this change other than the user is in a “less dangerous” place?

There is already a large warning when the user goes to this screen explaining the implications of making edits that they have to accept, and the code editor prevents a file from being saved if there are syntax errors. 5.2 also adds recovery mode. If users are having trouble and making mistakes in the editor, then I'd prefer to improve the current experience to prevent that instead of changing the default file to place them in a location that will hardly ever be useful.

Also, if this is switched to readme.txt, there is no syntax checking for that file type. This could be a problem if the theme directory switches to using readme.txt files to check for updates. The user would stop receiving theme updates if they make a mistake in the file.

I'm marking this as a close candidate pending a second opinion.

#3 @nerrad
5 years ago

  • Resolution set to wontfix
  • Status changed from new to closed

I agree with @desrosj. I don't see what benefits switching to readme.txt brings and as pointed out doesn't remove the potential for people to break updates in the future (or even the file header getting parsed for the theme details if/when themes support readme.txt).

Last edited 5 years ago by nerrad (previous) (diff)

#4 @desrosj
5 years ago

  • Keywords 2nd-opinion close removed
  • Milestone Awaiting Review deleted
Note: See TracTickets for help on using tickets.