Skip to content

Commit 6eabe30

Browse files
chore (typos) tidy up and spell check
Pretty up, spell check and fix typos everywhere signed-off-by David Brace <[email protected]>
1 parent 9f84c01 commit 6eabe30

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

CONTRIBUTING.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This document will help guide your experience to provide you with the best and m
2323
<BR>
2424
2525

26-
# Issues
26+
# Issues :bangbang:
2727
```Issues``` are a standard way of working and contributing to GitHub projects. GitHub Issues are the** 2nd most** common way (after Slack) that users interact and contribute to the project. Working with Issues requires you to make a few simple decisions.
2828
- is my issue more of a discussion topic?
2929
- Does my Issue relate to a Product?
@@ -134,7 +134,7 @@ New enhancements are referred to as OpenEBS Enhancement Proposals (OEPs). Anyone
134134
<BR>
135135

136136
> [!Important]
137-
> - Our Organization enforces **```Developer Certificate of Origin```** (DCO) on all on Pull Requests, as an additional safeguard for the OpenEBS project. This requires all **commit messages** to contain the ```Signed-off-by``` line, with an email address that matches the commit author name.
137+
> Our Organization enforces **```Developer Certificate of Origin```** (DCO) on all on Pull Requests, as an additional safeguard for the OpenEBS project. This requires all **commit messages** to contain the ```Signed-off-by``` line, with an email address that matches the commit author name.
138138

139139
> - This is a [well established and widely used mechanism](https://github.com/apps/dco) <BR>
140140
> - DCO assure's contributors have confirmed their right to license their contribution under the project's license. <BR>
@@ -153,22 +153,25 @@ You must certify that your committs and PR's are your own work and authourized b
153153
> ```Signed-off-by: Random J Developer <[email protected]>```
154154
>
155155
> Example of automated git cli command: <BR>
156-
> ```git commit -s -m "Sign off detraiuls and message. Does not include DCO signature line"```
156+
> ```git commit -s -m "Sign off details and message. Does not include DCO signature line"```
157157
> ```ruby
158-
> NOTE: the cli -s flag will auto add your DCO sign-off signature as a extra line in your committ messsage
158+
> NOTE: the cli -s flag will auto add your DCO sign-off signature as a extra line in your commit message
159159
> if you have setup you git Global config correctly.
160160
> ```
161161
> :information_source: **```INFO```:** <BR>
162-
> When using the GitHub Web App, you cannot auto DCO sign-off your committs. Your DCO signatiure line must be manually added each time, in each comitt. This is by design and enforced by the GitHub WebApp.
163-
164-
- Generally accepted GitHub DCO policy requires that all committing users must provide their ```real name``` (sorry, no pseudonyms or anonymous contributions).
165-
- If you set your ```user.name``` and ```user.email``` git configs, you can DCO sign your commits automatically with ```git commit -s```.
166-
- You can also use git [aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) like: ``` git config --global alias.ci 'commit -s' ```. Now you can commit with git ci and the commit will be signed.
162+
> :no_entry_sign: When using the GitHub Web App, you cannot auto DCO sign-off your commits. Your DCO signature line must be manually added each time, in each commit message. This is by design and enforced by the GitHub WebApp. <BR>
163+
> :white_check_mark: When using GitHub Desktop App, you can generate automatic DCO sign-off commits if your underlying git cli config is setup correctly. <BR>
164+
<BR>
167165

166+
The generally accepted GitHub DCO policy requires that all committing users must provide their ```real name``` in their DCO signature message (sorry, no pseudonyms or anonymous contributions). <BR>
167+
- If you set your ```user.name``` and ```user.email``` git configs, you can DCO sign your commits automatically with ```git commit -s```. <BR>
168+
- You can also use git [aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) like: ``` git config --global alias.ci 'commit -s' ```. Now you can commit with git ci and the commit will be signed. <BR>
169+
<BR>
168170

169171
---
170172

171173

174+
172175
## Regular Community Meeting
173176

174177
open EBS hosts a bi-weekly (fortnightly) community meeting on Tuesday 7:00an Americas/Los Angeles time, using the [CNCF's community event platform](https://community.cncf.io/openebs-community/). Please register for the event, prior to the meeting. You'd have to register for the meeting before the actual meeting time.

0 commit comments

Comments
 (0)