Skip to content

Commit 04b4b2b

Browse files
author
James Couball
committed
Initial version
0 parents  commit 04b4b2b

22 files changed

+624
-0
lines changed

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/.bundle/
2+
/.yardoc
3+
/_yardoc/
4+
/coverage/
5+
/doc/
6+
/pkg/
7+
/spec/reports/
8+
/tmp/
9+
10+
# rspec failure tracking
11+
.rspec_status
12+
13+
# Rubocop
14+
rubocop-report.json

.rubocop.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
AllCops:
2+
NewCops: enable
3+
# Output extra information for each offense to make it easier to diagnose:
4+
DisplayCopNames: true
5+
DisplayStyleGuide: true
6+
ExtraDetails: true
7+
# RuboCop enforces rules depending on the oldest version of Ruby which
8+
# your project supports:
9+
TargetRubyVersion: 2.6
10+
11+
# The default max line length is 80 characters
12+
Layout/LineLength:
13+
Max: 120
14+
15+
# The DSL for RSpec and the gemspec file make it very hard to limit block length:
16+
Metrics/BlockLength:
17+
Exclude:
18+
- "spec/**/*_spec.rb"
19+
- "*.gemspec"

.travis.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
language: ruby
3+
cache: bundler
4+
5+
rvm:
6+
- 2.6
7+
- 2.7
8+
- ruby-head
9+
10+
matrix:
11+
allow_failures:
12+
- rvm: ruby-head
13+
fast_finish: true

.yardopts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
--no-private
2+
--hide-void-return
3+
--markup-provider=redcarpet
4+
--markup markdown

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Change Log
2+
3+
## 0.1.0
4+
5+
See https://github.com/jcouball/ruby_git/releases/tag/v0.1.0

CONTRIBUTING.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Contributing to ruby_git
2+
3+
Thank you for your interest in contributing to the ruby_git project!
4+
5+
This document gives the guidelines for contributing to this project.
6+
These guidelines may not fit every situation. When contributing use your best
7+
judgement.
8+
9+
Propose changes to these guidelines with a pull request.
10+
11+
## How to contribute to ruby_git
12+
13+
You can contribute in two ways:
14+
15+
1. [Report an issue or make a feature request](#how-to-report-an-issue-or-make-a-feature-request)
16+
2. [Submit a code or documentation change](#how-to-submit-a-code-or-documentation-change)
17+
18+
## How to report an issue or make a feature request
19+
20+
ruby_git utilizes [GitHub Issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues)
21+
for issue tracking and feature requests.
22+
23+
Report an issue or feature request by [creating a ruby_git Github issue](https://github.com/jcouball/ruby_git/issues/new).
24+
Fill in the template to describe the issue or feature request the best you can.
25+
26+
## How to submit a code or documentation change
27+
28+
There is three step process for code or documentation changes:
29+
30+
1. [Commit your changes to a fork of ruby_git](#commit-changes-to-a-fork-of-ruby_git)
31+
2. [Create a pull request](#create-a-pull-request)
32+
3. [Get your pull request reviewed](#get-your-pull-request-reviewed)
33+
34+
### Commit changes to a fork of ruby_git
35+
36+
Make your changes in a fork of the ruby_git repository.
37+
38+
### Create a pull request
39+
40+
See [this article](https://help.github.com/articles/about-pull-requests/) if you
41+
are not familiar with GitHub Pull Requests.
42+
43+
Follow the instructions in the pull request template.
44+
45+
### Get your pull request reviewed
46+
47+
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).
48+
49+
Once your pull request is ready for review, request a review from at least one
50+
[maintainer](MAINTAINERS.md) and any number of other contributors.
51+
52+
During the review process, you may need to make additional commits which would
53+
need to be squashed. It may also be necessary to rebase to main again if other
54+
changes are merged before your PR.
55+
56+
At least one approval is required from a project maintainer before your pull
57+
request can be merged. The maintainer is responsible for ensuring that the pull
58+
request meets [the project's coding standards](#coding-standards).
59+
60+
## Coding standards
61+
62+
In order to ensure high quality, all pull requests must meet these requirements:
63+
64+
### 1 PR = 1 Commit
65+
* All commits for a PR must be squashed into one commit
66+
* 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)
67+
* The easiest way to ensure a fast forward merge is to rebase your local branch
68+
to the ruby_git main branch
69+
70+
### Unit tests
71+
* All changes must be accompanied by new or modified RSpec unit tests
72+
* The entire test suite must pass when `bundle exec rake spec` is run from the
73+
project's local working copy
74+
* The unit test suite must maintain 100% code coverage to pass
75+
76+
### Documentation
77+
* New and updated public methods must have [YARD](https://yardoc.org/)
78+
documentation added to them
79+
* New and updated public facing features should be documented in the project's
80+
[README.md](README.md)
81+
* All documentation must pass `yardstick` documentation analysis.
82+
* The documentation suite must maintain 100% documentation to pass
83+
84+
### Continuous Integration
85+
* All tests must pass in the project's [Travis CI](https://travis-ci.org/jcouball/ruby_git)
86+
build before the pull request will be merged
87+
88+
## Licensing
89+
90+
ruby_git uses [the MIT license](https://choosealicense.com/licenses/mit/) as
91+
declared in the [LICENSE](LICENSE) file.
92+
93+
Licensing is very important to open source projects. It helps ensure the
94+
software continues to be available under the terms that the author desired.
95+

Gemfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
4+
5+
# Specify your gem's dependencies in ruby_git.gemspec
6+
gemspec

Gemfile.lock

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
PATH
2+
remote: .
3+
specs:
4+
ruby_git (0.1.0)
5+
6+
GEM
7+
remote: https://rubygems.org/
8+
specs:
9+
ast (2.4.1)
10+
bump (0.9.0)
11+
bundler-audit (0.7.0.1)
12+
bundler (>= 1.2.0, < 3)
13+
thor (>= 0.18, < 2)
14+
diff-lcs (1.4.4)
15+
docile (1.3.2)
16+
json (2.3.1)
17+
parallel (1.19.2)
18+
parser (2.7.1.4)
19+
ast (~> 2.4.1)
20+
rainbow (3.0.0)
21+
rake (13.0.1)
22+
redcarpet (3.5.0)
23+
regexp_parser (1.7.1)
24+
rexml (3.2.4)
25+
rspec (3.9.0)
26+
rspec-core (~> 3.9.0)
27+
rspec-expectations (~> 3.9.0)
28+
rspec-mocks (~> 3.9.0)
29+
rspec-core (3.9.2)
30+
rspec-support (~> 3.9.3)
31+
rspec-expectations (3.9.2)
32+
diff-lcs (>= 1.2.0, < 2.0)
33+
rspec-support (~> 3.9.0)
34+
rspec-mocks (3.9.1)
35+
diff-lcs (>= 1.2.0, < 2.0)
36+
rspec-support (~> 3.9.0)
37+
rspec-support (3.9.3)
38+
rubocop (0.91.0)
39+
parallel (~> 1.10)
40+
parser (>= 2.7.1.1)
41+
rainbow (>= 2.2.2, < 4.0)
42+
regexp_parser (>= 1.7)
43+
rexml
44+
rubocop-ast (>= 0.4.0, < 1.0)
45+
ruby-progressbar (~> 1.7)
46+
unicode-display_width (>= 1.4.0, < 2.0)
47+
rubocop-ast (0.4.1)
48+
parser (>= 2.7.1.4)
49+
ruby-progressbar (1.10.1)
50+
simplecov (0.17.1)
51+
docile (~> 1.1)
52+
json (>= 1.8, < 3)
53+
simplecov-html (~> 0.10.0)
54+
simplecov-html (0.10.2)
55+
thor (1.0.1)
56+
unicode-display_width (1.7.0)
57+
yard (0.9.25)
58+
yardstick (0.9.9)
59+
yard (~> 0.8, >= 0.8.7.2)
60+
61+
PLATFORMS
62+
ruby
63+
64+
DEPENDENCIES
65+
bump (~> 0.9)
66+
bundler-audit (~> 0.7)
67+
rake (~> 13.0)
68+
redcarpet (~> 3.5)
69+
rspec (~> 3.9)
70+
rubocop (~> 0.91)
71+
ruby_git!
72+
simplecov (= 0.17.1)
73+
yard (~> 0.9)
74+
yardstick (~> 0.9)
75+
76+
BUNDLED WITH
77+
2.1.4

ISSUE_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Feature Request
2+
Delete this section if you are reporting a bug
3+
4+
### Description of the new feature
5+
Describe your feature here
6+
7+
## Bug Report
8+
Delete this section if you are requesting a feature
9+
10+
### Description of bug
11+
Describe your bug here
12+
13+
### Your environment
14+
* **Version of ruby_git**:
15+
* **Version of git**:
16+
* **Version of ruby**:
17+
* **Platform & Version (MacOS 10.15.6, Linux, Windows 10, etc.)**:
18+
19+
### Steps to reproduce the bug
20+
1.
21+
2.
22+
3.
23+
4.
24+
25+
### Expected behaviour
26+
What did you expect to happen?
27+
28+
### Actual behaviour
29+
What actually happened?

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2020 James Couball and contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)