search

jbranchaud / ocelot

Because you're awesome!
4 stars 1 forks source link

Remove opening and closing delimiters from specification #8

Closed jbranchaud closed 11 years ago

jbranchaud commented 11 years ago

@jurgns and I discussed this today and it seems that having the opening (---) and closing (...) delimiters as part of annotation is a bit verbose. Furthermore, it actually seems to be unnecessary. It was originally intended to denote if a particular commit message contained ocelot annotations and where those annotations started and stopped.

First, we don't need to denote particular commit messages, but rather we should consider any commit message when processing a repository. Those without specific ocelot annotations will just end up containing less rich information, but are nevertheless still parseable.

Second, we don't really need to know where the annotations start and stop. Rather, we can process an entire commit message and know that specific file annotations are proceeded by the [filename] syntax.

Based on this, it seems that we should move to remove the delimiters in subsequent versions of the specification.

jurgns commented 11 years ago

I think we've gone ahead and written this into some of the docs (README.md I think). Shall we move forward with this proposal?

jbranchaud commented 11 years ago

I actually already removed them as of ocelot-v0.1.3.md, so I think we can consider this issue closed.