You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Reporting an issue or making a feature request [here](https://github.com/ruby-git/ruby-git/issues/new).
25
-
2. Adding features or fixing bugs yourself and contributing your code to ruby-git.
23
+
Report an issue or feature request by [creating a ruby-git Github issue](https://github.com/ruby-git/ruby-git/issues/new).
24
+
Fill in the template to describe the issue or feature request the best you can.
26
25
27
-
### Contribution Process
26
+
##How to submit a code or documentation change
28
27
29
-
We have a 3 step process for contributions:
28
+
There is three step process for code or documentation changes:
30
29
31
-
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).
32
-
2. Create a GitHub Pull Request for your change, following the instructions in the pull request template.
33
-
3.Perform a [Code Review](#code-review-process) with the project maintainers on the pullrequest.
30
+
1.[Commit your changes to a forkof 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)
34
33
35
-
### Pull Request Requirements
36
-
In order to ensure high quality, we require that all pull requests to this project meet these specifications:
34
+
### Commit changes to a fork of ruby-git
37
35
38
-
1. Unit Testing: We require all the new code to include unit tests, and any fixes to pass previous units.
39
-
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.
40
-
3. Up-to-date Documentation: New methods as well as updated methods should have [YARD](https://yardoc.org/) documentation added to them
36
+
Make your changes in a fork of the ruby-git repository.
41
37
42
-
### Code Review Process
38
+
Each commit must include a [DCO sign-off](#developer-certificate-of-origin-dco)
39
+
by adding the line `Signed-off-by: Name <email>` to the end of the commit
40
+
message.
43
41
44
-
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.
42
+
### Create a pull request
45
43
46
-
Once you open a pull request, project maintainers will review your code and respond to your pull request with any feedback they might have.
44
+
See [this article](https://help.github.com/articles/about-pull-requests/) if you
45
+
are not familiar with GitHub Pull Requests.
47
46
48
-
The process at this point is as follows:
47
+
Follow the instructions in the pull request template.
49
48
50
-
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>.
51
-
2. When ready, your pull request will be merged into `master`, we may require you to rebase your PR to the latest `master`.
49
+
### Get your pull request reviewed
52
50
53
-
### Developer Certification of Origin (DCO)
51
+
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).
54
52
55
-
Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired.
53
+
Once your pull request is ready for review, request a review from at least one
54
+
[maintainer](MAINTAINERS.md) and any number of other contributors.
56
55
57
-
ruby-git uses [the MIT license](https://github.com/ruby-git/ruby-git/blob/master/LICENSE)
56
+
During the review process, you may need to make additional commits which would
57
+
need to be squashed. It may also be necessary to rebase to master again if other
58
+
changes are merged before your PR.
58
59
59
-
Detail about the LICENSE can be found [here](https://choosealicense.com/licenses/mit/)
60
+
At least one approval is required from a project maintainer before your pull
61
+
request can be merged. The maintainer is responsible for ensuring that the pull
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.
64
+
## Coding standards
62
65
63
-
The DCO is an attestation attached to every contribution made by every developer.
66
+
In order to ensure high quality, all pull requests must meet these requirements:
64
67
65
-
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/>.
68
+
### 1 PR = 1 Commit
69
+
* All commits for a PR must be squashed into one commit
70
+
* 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)
71
+
* The easiest way to ensure a fast forward merge is to rebase your local branch
72
+
to the ruby-git master branch
73
+
74
+
### Unit tests
75
+
* All changes must be accompanied by new or modified unit tests
76
+
* The entire test suite must pass when `bundle exec rake test` is run from the
77
+
project's local working copy
78
+
79
+
### Continuous Integration
80
+
* All tests must pass in the project's [Travis CI](https://travis-ci.org/ruby-git/ruby-git)
81
+
build before the pull request will be merged
82
+
83
+
### Documentation
84
+
* New and updated public methods must have [YARD](https://yardoc.org/)
85
+
documentation added to them
86
+
* New and updated public facing features should be documented in the project's
87
+
[README.md](README.md)
88
+
89
+
### Licensing sign-off
90
+
* Each commit must contain [the DCO sign-off](#developer-certificate-of-origin-dco)
91
+
in the form: `Signed-off-by: Name <email>`
92
+
93
+
## Licensing
94
+
95
+
ruby-git uses [the MIT license](https://choosealicense.com/licenses/mit/) as
96
+
declared in the [LICENSE](LICENSE) file.
97
+
98
+
Licensing is very important to open source projects. It helps ensure the
99
+
software continues to be available under the terms that the author desired.
100
+
101
+
### Developer Certificate of Origin (DCO)
102
+
103
+
This project requires that authors have permission to submit their contributions
104
+
under the MIT license. To make a good faith effort to ensure this, ruby-git
105
+
requires the [Developer Certificate of Origin (DCO)](https://elinux.org/Developer_Certificate_Of_Origin)
106
+
process be followed.
107
+
108
+
This process requires that each commit include a `Signed-off-by` line that
109
+
indicates the author accepts the DCO. Here is an example DCO sign-off line:
110
+
111
+
```
112
+
Signed-off-by: John Doe <john.doe@hisdomain.com>
113
+
```
114
+
115
+
The full text of the DCO version 1.1 is below or at <http://developercertificate.org/>.
66
116
67
117
```
68
118
Developer's Certificate of Origin 1.1
@@ -75,7 +125,7 @@ By making a contribution to this project, I certify that:
75
125
76
126
(b) The contribution is based upon previous work that, to the
77
127
best of my knowledge, is covered under an appropriate open
78
-
source license and I have the right under that license to
128
+
source license and I have the right under that license to
79
129
submit that work with modifications, whether created in whole
80
130
or in part by me, under the same open source license (unless
81
131
I am permitted to submit under a different license), as
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.
3
+
When making changes in this repository, one of the maintainers below must review and approve your pull request.
0 commit comments