Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-worked Changes file #23

Closed
wants to merge 1 commit into from
Closed

Re-worked Changes file #23

wants to merge 1 commit into from

Conversation

bricas
Copy link
Contributor

@bricas bricas commented Oct 11, 2012

I've re-worked the Changes file to be more CPAN::Changes::Spec-like. As mentioned in my commit, it doesn't yet validate due to a missing release date, though it's very close!

Sadly, this doesn't validate because of a missing release date for
version 0.08_03. It will be future compatible, though, when the release
date becomes an optional element.
@ribasushi
Copy link
Contributor

Can you elaborate a bit more on what are the incentives to target a particular spec? I am not trying to reject the patch outright, merely commenting that it changes a lot of existing Changelog structure for no apparent reason. Hence looking for clarification.

Cheers

@bricas
Copy link
Contributor Author

bricas commented Mar 10, 2013

Not sure what you mean by "no apparent reason" since the commit message states the reason -- i.e. to adhere to CPAN::Changes spec -- but allow me to elucidate as best I can :)

The point is to create a human readable & machine parsable changelog using a format widely used by existing distributions already on CPAN. The end result allows programmatic access to the data so that changelogs can be read from (think "most recent feed" for e.g.), written to and updated (think automated tools to update the version & release date in the changelog, for e.g.)

If you haven't already, please checkout http://changes.cpanhq.org/ for a bit more info.

I know the unified diff looks a wee-bit messy, but if you view the files side-by-side, you'll see the changes are actually relatively minor:

  • Remove "---" line markers
  • Remove starting pound signs (#)
  • Add single space before changelog marker (*)
  • Make spacing between changelog lines consistent

And that's basically all.

If there are other questions, let me know! Cheers :)

@dbsrgits-sync
Copy link

Fwiw I am for it.
On Mar 9, 2013 8:17 PM, "Brian Cassidy" notifications@github.com wrote:

Not sure what you mean by "no apparent reason" since the commit message
states the reason -- i.e. to adhere to CPAN::Changes spec -- but allow me
to elucidate as best I can :)

The point is to create a human readable & machine parsable changelog using
a format widely used by existing distributions already on CPAN. The end
result allows programmatic access to the data so that changelogs can be
read from (think "most recent feed" for e.g.), written to and updated
(think automated tools to update the version & release date in the
changelog, for e.g.)

If you haven't already, please checkout http://changes.cpanhq.org/ for a
bit more info.

I know the unified diff looks a wee-bit messy, but if you view the files
side-by-side, you'll see the changes are actually relatively minor:

  • Remove "---" line markers
  • Remove starting pound signs (#)
  • Add single space before changelog marker (*)
  • Make spacing between changelog lines consistent

And that's basically all.

If there are other questions, let me know! Cheers :)


Reply to this email directly or view it on GitHubhttps://github.com//pull/23#issuecomment-14674866
.


DBIx-Class-Devel mailing list
DBIx-Class-Devel@lists.scsys.co.uk
http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/dbix-class-devel

@frioux
Copy link
Member

frioux commented Oct 30, 2013

Went ahead and reimplemented it with the one caveat that instead of standardizing on extra whitespace we standardize on less (since that's mostly how it's done in the rest of the file. Thanks @bricas!

@ribasushi
Copy link
Contributor

For the record I was going to reject this patch with no changes, but never got around to it due to my chronic suckiness. Anyway, what's done is done, just relinking the objections here to hopefully prevent future blind applications of similar mindless patches. The Changes spec as it stands is close to unusable as detailed here: metacpan/metacpan-web#948

Cheers

@ribasushi ribasushi closed this Oct 30, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants