gitlog 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 212e5916fc447695e650d6d3ff2c4944bb505231
-  data.tar.gz: 2427bfd25ee7c189428aacd9da3b5799d6ffb039
+  metadata.gz: b073d6ce6cd942ac6a7fef727732c0161b68f6e0
+  data.tar.gz: c1f3b3718f096180175771b06e0e72fc8344f2aa
 SHA512:
-  metadata.gz: 21d58e41d6f55bd1e71605d7bfe67cdef6a039ae5282bbf57991f02d8a7dd051936690cbfe09b9ddd3d72c9efff18be2c64f01d899072f324c154487fab67b12
-  data.tar.gz: bffdd70c56f92b4083edd7d1f403653d9055fd2138223fe5e07bd9dada2eacdcc76099379edcc82ee33f1639f8eee0c297f1d23393839c351a5f3a1548aba6ce
+  metadata.gz: 14e6f75c30fc900ff2a89f32d4988227c7e56e0763a849e83cf929b4769b8279c1d27c32d4229c349a28576b53436a9d9515fd2db2cac51c1627144a63da6a23
+  data.tar.gz: 47b4c71caf94b85cdc3d3f135cafb55ac12f7ae1ef81491b2af1124138315e8fbc7c06b0f05b201cfd14ee8528b2f09cd45bb9f02b1aaa6916429507baaa0af2

data/README.md

@@ -1,8 +1,53 @@
+
 # GitLog
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlog`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to GitLog! GitLog is a tool to get meaningful insights and formatted log of the work you have done in a git repo. 
+Since, nothing comes free of cost, you have to follow a few rules while writing your git commits and this tool serves you well.
+
+## Idea
+The idea came up while struggling with daily updates from the team over the standups. While the standup, many people just go through their git commits and try to see what they have worked on and try to recap that. But if someone has a large commit history, then the updates are a mess. So, to formalise this and create a defined structure for the updates, we came up with this.
+
+Another story is with the timesheets. People forget to fill up their timesheets on regular basis and after 2-3 days they totally forget what they worked on. And again, they end up writing some messy updates in their timesheets as well
+
+## Structure 
+
+The commits are structured into following types. Every commit has to fall under one of these types.
+
+| type |description  |
+|--|--|
+| ***feat*** | A new feature |
+| ***fix*** | A bug or defect resolution |
+| ***refactor*** |A code change that neither fixes a bug nor adds a feature  |
+| ***test*** | Adding or modifying test scripts or settings |
+| ***chore*** | Changes to the build process or auxiliary tools, adding libraries or changing project configuration settings |
+| ***style*** |Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)  |
+| ***perf*** | A code change that improves performance |
+| ***docs*** | Changes to ReadMe or other documentation |
+
+## Rules to write commits
+Each commit message should therefore contain three components to clarify it's context:
+
+1.  **Type:** The type classifies the _nature_ of the change being made(described above). It should always conform to one of the following types and be _lowercase_
+
+2.  **Scope:** The scope classifies where the change is being made, it might describe a certain task, an object or even a set of files. This term should _include no spaces_, but can include other characters, including capital letters and/or slashes to indicate scope paths.
+3.  **Subject:** The subject contains a short description of the modification that was made. It should always begin with a lowercase letter and does _not_ contain a period.
+
+###### For optimal readability, it’s important that the overall commit message be kept as short as possible. As a general rule of thumb, aim for a 50 character limit, but consider 69 characters the hard limit. This is primarily because GitHub will truncate anything beyond 69 characters. Always write your subject in an imperative fashion, as if you were commanding someone. In other words, lines should start with “Fix,” “Add,” or “Change” instead of “Fixed,” “Added,” or “Changed.” So keep all verbs in the present tense.
+
+### **Commit Message Format**
+
+When writing a commit message, it’s important for us to maintain a consistent, predictable structure. This allows for easier scannability and searchability. Each message should contain a Type, Scope and Subject using the following syntax:
+
+> ***type(Scope): subject description in all lowercase***
+
+So, for example:
+> ***feat(UsernameInput): add username text field with validation handling***
+
+You can also choose to define your scope as a path to better organize topics:
+
+> ***feat(onboarding/username): add username text field with validation handling***
 
-TODO: Delete this and the text above, and describe your gem
+It’s critical that this syntax is precisely followed. This allows us to list separately the different types of modifications that are included in the build, such as features, bug fixes, refactoring, project configuration changes, tests, or stylistic updates to code.
 
 ## Installation
 
@@ -21,8 +66,10 @@ Or install it yourself as:
     $ gem install gitlog
 
 ## Usage
+Usage is simple. Just `cd` to the git repo and do `gitlog my`
+1. `gitlog my` - to get all the logs for today
+2. `gitlog my -d yyyy-MM-dd` - to get all the logs for specified day
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,7 +79,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ravindrasoni/gitlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +87,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Gitlogs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gitlog/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the GitLog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[ravindrasoni]/gitlog/blob/master/CODE_OF_CONDUCT.md).

data/lib/gitlog/log.rb

@@ -220,7 +220,7 @@ module GitLog
       if author.nil?
         author = author()
       end
-      print_log("log_style", log_style)
+      # print_log("log_style", log_style)
   	  git_logs = git_log_on_date(specific_date, author, current_branch_only)
   	  logs = git_formatted_log(git_logs,log_style)
   	  puts logs

data/lib/gitlog/version.rb

@@ -1,3 +1,3 @@
 module GitLog
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ravindra Soni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler