Skip to content

Commit 648fb3e

Browse files
authored
Merge pull request #20 from cmckee786/patching
2 parents aa86d64 + af6990c commit 648fb3e

File tree

2 files changed

+22
-13
lines changed

2 files changed

+22
-13
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Outlined below are a set of objectives this repository attempts to provide.
4242
## To Begin Contributing
4343

4444
ProLUG asks all contributors to understand and adhere to the principles and guidelines detailed
45-
in the [contributing.md](https://github.com/ProfessionalLinuxUsersGroup/lac/blob/main/src/contributing.md) markdown file.
45+
in the [contributing.md](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/src/contributing.md) markdown file.
4646
Contributors found significantly deviating from these policies will have their work discarded appropriately.
4747

4848
Contributors will be provided with supplementary material to begin building out unit worksheet labs
@@ -51,12 +51,12 @@ and templates within the project managed issues board.
5151
To start contributing:
5252

5353
- Understand the repository objectives
54-
- Read the [contributing.md](https://github.com/ProfessionalLinuxUsersGroup/lac/blob/main/src/contributing.md) markdown
55-
- Look over the [template pages wiki](https://github.com/ProfessionalLinuxUsersGroup/lac/wiki), or directly here:
56-
- Pages: [intro](https://github.com/ProfessionalLinuxUsersGroup/lac/blob/main/ref/intro.md),
57-
[bonus](https://github.com/ProfessionalLinuxUsersGroup/lac/blob/main/ref/ub.md),
58-
[lab](https://github.com/ProfessionalLinuxUsersGroup/lac/blob/main/ref/ulab.md),
59-
[worksheet](https://github.com/ProfessionalLinuxUsersGroup/lac/blob/main/ref/uws.md)
60-
- Request to be assigned a task within the repo [Issues](https://github.com/ProfessionalLinuxUsersGroup/lac/issues) tab
54+
- Read the [contributing.md](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/src/contributing.md) markdown
55+
- Look over the [template pages wiki](https://github.com/ProfessionalLinuxUsersGroup/psc/wiki), or directly here:
56+
- Pages: [intro](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/intro.md),
57+
[bonus](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/ub.md),
58+
[lab](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/ulab.md),
59+
[worksheet](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/uws.md)
60+
- Request to be assigned a task within the repo [Issues](https://github.com/ProfessionalLinuxUsersGroup/psc/issues) tab
6161
- Fork this repository and create a development branch for eventual pull requests
6262
- Strictly adhere to contemporary GitHub contribution decorum to facilitate the version control process

src/contributing.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div class="flex-container">
22
<img src="https://github.com/ProfessionalLinuxUsersGroup/img/blob/main/Assets/Logos/ProLUG_Round_Transparent_LOGO.png?raw=true" width="64" height="64"></img>
33
<p>
4-
<h1>Contributing to the ProLUG Linux Sysadmin Course Book</h1>
4+
<h1>Contributing to the ProLUG Linux Systems Security Course Book</h1>
55
</p>
66
</div>
77

@@ -191,21 +191,30 @@ git switch -c unit1-worksheet
191191

192192
Make changes to the `u1ws.md`.
193193

194-
## Understand a few Best Practices
194+
## Consider a few Useful Practices
195195

196196
---
197197

198+
The practices presented below are not required to contribute to the ProLUG
199+
course books but can streamline contributing to any project and are considered
200+
to some as best practice or incredibly useful when engaging in version control
201+
with Git.
202+
198203
### Git Rebasing
199204

200205
<div class="warning">
201-
<strong>FIRST AND FOREMOST, ONLY REBASE IN LOCAL REPOSITORIES, NEVER REBASE
206+
<strong>FIRST AND FOREMOST, ONLY REBASE IN LOCAL REPOSITORIES. NEVER REBASE
202207
A PUBLIC BRANCH OR REPOSITORY UNLESS YOU FULLY UNDERSTAND THE CONSEQUENCES.
203208
YOU HAVE BEEN WARNED.</strong>
204209
</div>
205210

206211
Proper implementation of rebasing can leave a clean, and easily readable
207-
commit history for all concerned parties. The Git documentation provides a
208-
succinct explanation of its utility and how it **could potentially ruin a project**.
212+
commit history for all concerned parties. Rebasing can also facilitate the
213+
management of branches and working directories in a notably active project.
214+
215+
The Git documentation provides a succinct explanation of its utility but
216+
also how it **could potentially ruin a project** and erase the work of other
217+
contributors.
209218

210219
Rebasing also plays a role in facilitating any commit reverts that may need
211220
to be made in the future. More on that will follow.

0 commit comments

Comments
 (0)