git 1.6.0.pre1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 291adaa24da09656259518cf50d18882222a6704c742f70d266378a7c4d440cc
-  data.tar.gz: 46639fb4a5542f2354d9713dd47adca9349fda39a8b0a6a1d739e830214a1c05
+  metadata.gz: 87d2d900d69f6d803a09dab4f7668b550bc21cecbf51194b494f8b9366dce3d7
+  data.tar.gz: f8c1dc4b41a65b7c562f496f78a7d0f9f8ad98f26b70588186b5a890f058873b
 SHA512:
-  metadata.gz: 3bd0c914126e45b381671af36637e226817f7894164344c3abed242e3ba34a414290a9adceff25e7cc931be89192d17fe2510945d4391ffd35e994c79f71dab0
-  data.tar.gz: e249b429712dd287389f13d59e09c344e372b6d77189fa3baf1b81b63126f93e8f71c752b90c0f1227aa5d374efed4ee5aa572aca55832276c13ed1e86ddaee7
+  metadata.gz: 9c4364cfc57fd1eb54be4c5229ca0b14b4d83227d08fabb57e0c326dee91be43bb1560376f013965f2377f651ad64900b5bd90ff96737855d8acdcb87cef7ac2
+  data.tar.gz: 1d1114b7f1a2af9964e57e5cac34c8c88ffddebb39f79cdad89023827a3863697db435055c08961653a7a82c6cdf9f983e6c3b4119002c75b5f263acf2830e3e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.6.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.6.0
+
 ## 1.6.0.pre1
 
 See https://github.com/ruby-git/ruby-git/releases/tag/v1.6.0.pre1

data/CONTRIBUTING.md

@@ -1,68 +1,118 @@
 # Contributing to ruby-git
 
-Thank you for your interest in contributing to this project.
+Thank you for your interest in contributing to the ruby-git project.
 
-These are mostly guidelines, not rules. 
-Use your best judgment, and feel free to propose changes to this document in a pull request.
+This document gives the guidelines for contributing to the ruby-git project.
+These guidelines may not fit every situation.  When contributing use your best
+judgement.
 
-#### Table Of Contents
+Propose changes to these guidelines with a pull request.
 
-[How Can I Contribute?](#how-can-i-contribute)
-  * [Submitting Issues](#submitting-issues)
-  * [Contribution Process](#contribution-process)
-  * [Pull Request Requirements](#pull-request-requirements)
-  * [Code Review Process](#code-review-process)
-  * [Developer Certification of Origin (DCO)](#developer-certification-of-origin-dco)
+## How to contribute to ruby-git
 
+You can contribute in two ways:
 
-## How Can I Contribute?
+1. [Report an issue or make a feature request](#how-to-report-an-issue-or-make-a-feature-request)
+2. [Submit a code or documentation change](#how-to-submit-a-code-or-documentation-change)
 
-### Submitting Issues
+## How to report an issue or make a feature request
 
-We utilize **GitHub Issues** for issue tracking and contributions. You can contribute in two ways:
+ruby-git utilizes [GitHub Issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues)
+for issue tracking and feature requests.
 
-1. Reporting an issue or making a feature request [here](https://github.com/ruby-git/ruby-git/issues/new).
-2. Adding features or fixing bugs yourself and contributing your code to ruby-git.
+Report an issue or feature request by [creating a ruby-git Github issue](https://github.com/ruby-git/ruby-git/issues/new).
+Fill in the template to describe the issue or feature request the best you can.
 
-### Contribution Process
+## How to submit a code or documentation change
 
-We have a 3 step process for contributions:
+There is three step process for code or documentation changes:
 
-1. Commit changes to a git branch in your fork.  Making sure to sign-off those changes for the [Developer Certificate of Origin](#developer-certification-of-origin-dco).
-2. Create a GitHub Pull Request for your change, following the instructions in the pull request template.
-3. Perform a [Code Review](#code-review-process) with the project maintainers on the pull request.
+1. [Commit your changes to a fork of ruby-git](#commit-changes-to-a-fork-of-ruby-git)
+2. [Create a pull request](#create-a-pull-request)
+3. [Get your pull request reviewed](#get-your-pull-request-reviewed)
 
-### Pull Request Requirements
-In order to ensure high quality, we require that all pull requests to this project meet these specifications:
+### Commit changes to a fork of ruby-git
 
-1. Unit Testing: We require all the new code to include unit tests, and any fixes to pass previous units.
-2. Green CI Tests: We are using [Travis CI](https://travis-ci.org/ruby-git/ruby-git) to run unit tests on various ruby versions, we expect them to all pass before a pull request will be merged.
-3. Up-to-date Documentation: New methods as well as updated methods should have [YARD](https://yardoc.org/) documentation added to them
+Make your changes in a fork of the ruby-git repository.
 
-### Code Review Process
+Each commit must include a [DCO sign-off](#developer-certificate-of-origin-dco)
+by adding the line `Signed-off-by: Name <email>` to the end of the commit
+message.
 
-Code review takes place in GitHub pull requests. See [this article](https://help.github.com/articles/about-pull-requests/) if you're not familiar with GitHub Pull Requests.
+### Create a pull request
 
-Once you open a pull request, project maintainers will review your code and respond to your pull request with any feedback they might have. 
+See [this article](https://help.github.com/articles/about-pull-requests/) if you
+are not familiar with GitHub Pull Requests.
 
-The process at this point is as follows:
+Follow the instructions in the pull request template.
 
-1. One thumbs-up (:+1:) is required from project maintainers. See the master maintainers document for the ruby-git project at <https://github.com/ruby-git/ruby-git/blob/master/MAINTAINERS.md>.
-2. When ready, your pull request will be merged into `master`, we may require you to rebase your PR to the latest `master`.
+### Get your pull request reviewed
 
-### Developer Certification of Origin (DCO)
+Code review takes place in a GitHub pull request using the [the Github pull request review feature](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews).
 
-Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired.
+Once your pull request is ready for review, request a review from at least one
+[maintainer](MAINTAINERS.md) and any number of other contributors.
 
-ruby-git uses [the MIT license](https://github.com/ruby-git/ruby-git/blob/master/LICENSE)
+During the review process, you may need to make additional commits which would
+need to be squashed.  It may also be necessary to rebase to master again if other
+changes are merged before your PR.
 
-Detail about the LICENSE can be found [here](https://choosealicense.com/licenses/mit/)
+At least one approval is required from a project maintainer before your pull
+request can be merged.  The maintainer is responsible for ensuring that the pull
+request meets [the project's coding standards](#coding-standards).
 
-To make a good faith effort to ensure these criteria are met, ruby-git requires the Developer Certificate of Origin (DCO) process to be followed.
+## Coding standards
 
-The DCO is an attestation attached to every contribution made by every developer. 
+In order to ensure high quality, all pull requests must meet these requirements:
 
-In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO, which you can find below or at <http://developercertificate.org/>.
+### 1 PR = 1 Commit
+  * All commits for a PR must be squashed into one commit
+  * To avoid an extra merge commit, the PR must be able to be merged as [a fast forward merge](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging)
+  * The easiest way to ensure a fast forward merge is to rebase your local branch
+    to the ruby-git master branch
+
+### Unit tests
+  * All changes must be accompanied by new or modified unit tests
+  * The entire test suite must pass when `bundle exec rake test` is run from the
+    project's local working copy
+
+### Continuous Integration
+  * All tests must pass in the project's [Travis CI](https://travis-ci.org/ruby-git/ruby-git)
+    build before the pull request will be merged
+
+### Documentation
+  * New and updated public methods must have [YARD](https://yardoc.org/)
+    documentation added to them
+  * New and updated public facing features should be documented in the project's
+    [README.md](README.md)
+
+### Licensing sign-off
+  * Each commit must contain [the DCO sign-off](#developer-certificate-of-origin-dco)
+    in the form:  `Signed-off-by: Name <email>`
+
+## Licensing
+
+ruby-git uses [the MIT license](https://choosealicense.com/licenses/mit/) as
+declared in the [LICENSE](LICENSE) file.
+
+Licensing is very important to open source projects. It helps ensure the
+software continues to be available under the terms that the author desired.
+
+### Developer Certificate of Origin (DCO)
+
+This project requires that authors have permission to submit their contributions
+under the MIT license. To make a good faith effort to ensure this, ruby-git
+requires the [Developer Certificate of Origin (DCO)](https://elinux.org/Developer_Certificate_Of_Origin)
+process be followed.
+
+This process requires that each commit include a `Signed-off-by` line that
+indicates the author accepts the DCO.  Here is an example DCO sign-off line:
+
+```
+Signed-off-by: John Doe <john.doe@hisdomain.com>
+```
+
+The full text of the DCO version 1.1 is below or at <http://developercertificate.org/>.
 
 ```
 Developer's Certificate of Origin 1.1
@@ -75,7 +125,7 @@ By making a contribution to this project, I certify that:
 
 (b) The contribution is based upon previous work that, to the
     best of my knowledge, is covered under an appropriate open
-    source license and I have the right under that license to   
+    source license and I have the right under that license to
     submit that work with modifications, whether created in whole
     or in part by me, under the same open source license (unless
     I am permitted to submit under a different license), as

data/MAINTAINERS.md

@@ -1,8 +1,9 @@
 # Maintainers
 
-When making changes to the system, this file tells you who needs to review your patch - you need at least two maintainers to provide a :+1: on your pull request.
+When making changes in this repository, one of the maintainers below must review and approve your pull request.
 
 ### Maintainers
 
 * [Per Lundberg](https://github.com/perlun)
-* [Vern Burton](https://github.com/tarcinil)
+* [Vern Burton](https://github.com/tarcinil)
+* [James Couball](https://github.com/jcouball)

data/lib/git.rb

@@ -19,6 +19,7 @@ require 'git/repository'
 require 'git/status'
 require 'git/stash'
 require 'git/stashes'
+require 'git/version'
 require 'git/working_directory'
 
 lib = Git::Lib.new(nil, nil)
@@ -34,7 +35,7 @@ end
 # and more.  You should be able to do most fundamental git
 # operations with this library.
 #
-# This module provides the basic functions to open a git 
+# This module provides the basic functions to open a git
 # reference to work with. You can open a working directory,
 # open a bare repository, initialize a new repo or clone an
 # existing remote repository.
@@ -42,7 +43,7 @@ end
 # Author::    Scott Chacon (mailto:schacon@gmail.com)
 # License::   MIT License
 module Git
-  
+
   #g.config('user.name', 'Scott Chacon') # sets value
   #g.config('user.email', 'email@email.com')  # sets value
   #g.config('user.name')  # returns 'Scott Chacon'
@@ -82,7 +83,7 @@ module Git
   def self.bare(git_dir, options = {})
     Base.bare(git_dir, options)
   end
-    
+
   # clones a remote repository
   #
   # options
@@ -110,7 +111,7 @@ module Git
     repo.checkout("origin/#{options[:branch]}") if options[:branch]
     Dir.chdir(repo.dir.to_s) { FileUtils.rm_r '.git' }
   end
-  
+
   # Same as g.config, but forces it to be at the global level
   #
   #g.config('user.name', 'Scott Chacon') # sets value
@@ -139,8 +140,8 @@ module Git
   def self.init(working_dir = '.', options = {})
     Base.init(working_dir, options)
   end
-    
-  # returns a Hash containing information about the references 
+
+  # returns a Hash containing information about the references
   # of the target repository
   #
   # @param [String|NilClass] location the target repository location or nil for '.'
@@ -150,7 +151,7 @@ module Git
   end
 
   # open an existing git working directory
-  # 
+  #
   # this will most likely be the most common way to create
   # a git reference, referring to a working directory.
   # if not provided in the options, the library will assume
@@ -162,5 +163,5 @@ module Git
   def self.open(working_dir, options = {})
     Base.open(working_dir, options)
   end
-    
+
 end

data/lib/git/branch.rb

@@ -37,7 +37,7 @@ module Git
     #   # do other stuff
     #   return true # auto commits and switches back
     # end
-    def in_branch (message = 'in branch work')
+    def in_branch(message = 'in branch work')
       old_current = @base.lib.branch_current
       checkout
       if yield

data/lib/git/version.rb

@@ -1,5 +1,5 @@
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='1.6.0.pre1'
+  VERSION='1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 1.6.0.pre1
+  version: 1.6.0
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rchardet