我正在发布一个我已经使用了几年的PHP框架到github上。一直在尝试阅读有关项目应该如何正确构建以及应该添加哪些额外文件,例如readme等方面的最佳实践。但是在谷歌上一直没有找到合适的答案。请问是否有人可以向我指出一个好的示例项目或任何好的文章。
一些在Git(hub)上托管的PHP项目包括:
确保没有临时文件等被提交到仓库中,可以创建一个.gitignore
文件,并将一些readme之类的东西添加到仓库的根目录下。
任何配置文件都应该被忽略,而示例配置文件应该被放在仓库中。
建议使用Github支持的格式,比如Markdown,来编写readme文件。这会让你的仓库首页看起来更好。
你可能需要遵循某种类命名规则,以便更容易地实现自动加载。例如,类MyFramework_Controller
应该位于目录/lib/MyFramework/Controller.php
中。
现在只需要创建一些基本的布局即可,这样我们才能更容易地提出建议。