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

Adding the date to the routes annotation is not helping #136

Closed
pupeno opened this issue Aug 14, 2013 · 7 comments
Closed

Adding the date to the routes annotation is not helping #136

pupeno opened this issue Aug 14, 2013 · 7 comments
Assignees
Labels
Milestone

Comments

@pupeno
Copy link

pupeno commented Aug 14, 2013

We annotate all our models and the routes files using this gem and it's very useful, but having the date in the routes file is causing us some trouble. I'm referring to:

#== Route Map
# Generated on 13 Aug 2013 12:43

many times, more than one developer runs annotate and the merge would have been uneventful because either we added different actions/controllers or the result of annotating is the same for both; except for the date and time. That date and time is the reason why many of our merges fail.

Obviously it's not a big deal, doing the manual merge is trivial, but it generates noise. Now we have many merge commits which are just one comment line in difference and that's make it harder to spot the real merge commits, those dealing with actual functional conflicts.

Furthermore, the information provided in that comment is not essential. We don't need to know exactly the date and time when the routes was annotated, and if we need to know when the file changed last, we have source control that provides us with a lot of information.

I would recommend removing it all together; but if some people find it useful, I'd like to at least have an option to remove it.

@dmagliola
Copy link

This is also a problem in my team, I'd love to see this changed!

@alexch
Copy link
Collaborator

alexch commented Aug 14, 2013

+1 on removing the date from the route annotation

@ghost ghost assigned ctran Aug 15, 2013
@pkuczynski
Copy link

+1 on that. very annoying when annotate run via guard_annotate, which cause endless test execution (unless I remove routes.rb from watch list, which is not ideal either)

@ctran ctran modified the milestones: 2.6.2, 2.7.0, 2.6.3 Feb 26, 2014
@ctran
Copy link
Owner

ctran commented Feb 26, 2014

Checkout the develop branch for the new option "-no-timestamp".

@pkuczynski
Copy link

Could this be a default behaviour with an option to turn timestamp on?

@alexch
Copy link
Collaborator

alexch commented Feb 26, 2014

On Wed, Feb 26, 2014 at 9:45 AM, Piotr Kuczynski
notifications@github.comwrote:

Could this be a default behaviour with an option to turn timestamp on?

+1 ... The default should be the least disruptive. Who cares when a
particular developer ran a particular script anyway?

@ctran
Copy link
Owner

ctran commented Feb 26, 2014

Sure, I'll make the change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants