Skip to content
This repository has been archived by the owner on May 16, 2021. It is now read-only.

Add regex to allow single line versions. #15

Merged
merged 3 commits into from
Sep 22, 2016

Conversation

dotmpe
Copy link
Contributor

@dotmpe dotmpe commented Sep 20, 2016

Regex matching lines starting with digit, followed by
semver allowed characters only.

Enables use of rST definitions lists for main changelog format.


See commit msg above. This is my first ruby hack, I cant say I know much about Ruby commit etiquette. Please bear with me.

The additional regex loosens the title prefix/underline requirement a bit. It enables changelogs such as:

https://raw.githubusercontent.com/dotmpe/git-versioning/master/ChangeLog.rst
(https://github.com/dotmpe/git-versioning/blob/master/ChangeLog.rst)

Chandler works like a charm, thanks!

Regex matching lines starting with digit, followed by
semver allowed characters only.

Enables use of rST definitions lists for main changelog format.
@mattbrictson
Copy link
Owner

Thanks for the PR! Great to see people using Chandler and helping improve it. 😄

Generally, to accept a PR I need you to provide 2 things:

  • A CHANGELOG entry describing the improvement you made
  • Tests

If you are comfortable enough with Ruby to successfully run the test suite (just run rake as explained in the CONTRIBUTING.md document), then I think adding a test for this PR should be fairly simple. Add a sample changelog to the test/fixtures/changelog, then write a corresponding test in changelog_test.rb. The existing tests in that file should be self-explanatory; feel free to copy and paste.

If you get stuck, let me know and I can help out. Thanks!

@dotmpe
Copy link
Contributor Author

dotmpe commented Sep 21, 2016

That was helpful. Fyi 'bundler' was the only thing missing in ./bin/setup. Tests are running and I'm looking at all the goodies now.

I'll be committing and looking to update PR shortly.

@@ -6,7 +6,7 @@ chandler is in a pre-1.0 state. This means that its APIs and behavior are subjec

## [Unreleased][]

* Your contribution here!
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put the Your contribution here! bullet back in? I like to keep in there as a instruction for future contributors.

@mattbrictson
Copy link
Owner

Excellent! Thanks for the PR! 🙇

@mattbrictson mattbrictson merged commit d8259e1 into mattbrictson:master Sep 22, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants