wpengine / phpcompat

WordPress Plugin: PHP Compatibility Checker

Home Page:https://wordpress.org/plugins/php-compatibility-checker/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Additional repo management recommendations

jeffpaul opened this issue · comments

Is your enhancement related to a problem? Please describe.
On top of the recommended updates in #282, #283, and #284 I'd recommend the following

  • create a CONTRIBUTING.md file so potential contributors know what is expected from them
  • add Release Instructions to CONTRIBUTING.md so that future maintainers know the process to reliably ship a release on the project
  • add a CHANGELOG.md file specific to GitHub to apply a standard in tracking changes to the project
  • add a CREDITS.md file to acknowledge folks who've contributed to the project
  • standardize the README.md file differently than the readme.txt file as the .MD file is specific to GitHub while the .TXT version is specific to WordPress.org

Describe the solution you'd like
I'm happy to help handle PRs on all the above, but want to get confirmation that those updates are desired before I spend time on them.

Designs

Describe alternatives you've considered

Additional context