Open Potherca opened 9 years ago
Add a CHANGELOG
Do we really need a changelog file? Pointing to the projects release page on github should do the trick
A changelog is kinda required for breaking changes (at least). On Sep 1, 2015 10:42 AM, "usox" notifications@github.com wrote:
Add a CHANGELOG
Do we really need a changelog file? Pointing to the projects release page on github should do the trick
— Reply to this email directly or view it on GitHub https://github.com/phptal/PHPTAL/issues/41#issuecomment-136651425.
I updated the readme and the composer.json in our fork some time ago so I tried to backport some of the changes including some of the proposed suggestions. Any thoughts? https://github.com/usox/PHPTAL/tree/WIP/readme_and_composer_update
@usox yes: send a PR for review :-)
Well ok. Actually, I wanted to talk about dropping the phing targets before creating the pull request :-)
Various parts of the
README
file need updating or changing to be more up-to-date. Also, some additions seem in order.My suggestions would be to:
Readme File
(Dependencies have already been added to
composer.json
in #43, documentation needs to mention that the developer dependencies are added when runningcomposer install
).Other files
CONTRIBUTING.md
fileCOPYING
toLICENSE
- #43CHANGELOG
- #52Anybody else have opinions/thoughts/suggestions about this?