ploeh / Hyprlinkr

A URI building helper library for ASP.NET Web API
MIT License
198 stars 34 forks source link

Version / Readme / Example application #8

Closed dhilgarth closed 11 years ago

dhilgarth commented 11 years ago

A general question: Do you want me to update the version number when making changes and include that in the pull request? I think versioning is your responsibility, that's why I haven't done that so far. What about the Readme? Currently, it doesn't reflect the fact that the default API route has been changed. Additionally it doesn't show an example for the ResourceLinkVerifier. Should I have changed the Readme along with the source code changes? The example application also doesn't contain examples for the features I added. Should I have added them?

ploeh commented 11 years ago

Don't bother with the version numbers - they are better handled by a central authority (currently: me). This isn't because I want to exercise sovereign power, but because it's simply easier that way. Here's why:

Imagine that you submit a pull request with a new feature. If the old version was 0.4.0, the new version should be 0.5.0.

Imagine that someone else submits a pull request with a bug fix. If the old version 0.4.0, the new version should be 0.4.1.

If both of those pull requests contain updated version numbers, the resulting version is 0.4.1, but should really have been 0.5.1 (or perhaps simply 0.5.0 if both pull requests are bundled in the same release).

By handling version numbers by a central authority, the correct version can be assigned.


When it comes to the ReadMe, you are more than welcome to submit one or more pull requests as you suggest above :)

dhilgarth commented 11 years ago

About the version numbers: That's exactly the reason I haven't done it up to now.

About the read me: Will do