8:32 p.m.
We had an open item to define a common way to conclude each chapter, and
now it's something you can help with.
https://github.com/theopensourceway/guidebook/issues/160
This is a task someone can do within a few hours, I reckon—or about
fifteen minutes a chapter, if smaller chunks helps you imagine it.
You can read or scan through each chapter (twenty of them), then write
up a conclusion using the template/example.
To do this, here are the steps to follow for each chapter:
1. Pick a chapter in the Final Review column:
https://github.com/theopensourceway/guidebook/projects/1#column-8008213
2. Click the card title > the card slides out from the right.
3. On the card look at the first comment at the top, it will say "File
in repo: some_name.adoc".
4. Go to this page and scroll down until you see 'some_name.adoc', then
click on 'some_name.adoc':
https://github.com/theopensourceway/guidebook
5. This takes you to a page [1] for the file in the repo where you can
edit it. Now click on the "pen" icon between the [Raw][Blame] buttons
and the "trash" icon.
6. In the "Edit file" area, scroll to the bottom of the page and look
for a last block of text beginning with "== Conclusion". If there is
already a conclusion, then you can close this tab satisfied that you
have confirmed this one has a conclusion. Return to the beginning to
check the next chapter.
7. If there is no "== Conclusion" block, spend a few minutes scanning
the chapter and writing a "== Conclusion" block for the chapter. Here is
the format from Issue #160:
>>>
== Conclusion
This chapter discussed solutions to common problems with Foo, including
Bar and Baaz, and several examples of Quux. Finally, the chapter
concludes with a long discussion of Lorem Ipsum Dolor ..."
<<<<
8. You are now going to submit these for a "Pull Request", meaning you
are going to hand them over to one of us to review for inclusion. In
this step we'll do any clean-up, ask any questions, and so forth. In
most cases, we'll do a light edit and commit your change to the main repo.
9. You can use the "Preview changes" area to see your changes in place
and make sure they look correct. Then go to the "Commit changes" area below.
10. In the first field below the words "Commit changes" by your user
icon—the field has a gray "Update some_name.adoc"—replace the text with
something short such as, "Adding chapter Conclusion as per template".
11. In the area "Add an optional extended description...", you can add
any additional context/reason why, comments, questions, etc. you have
around this commit. You are handing this block of text off to another
person, do you have anything you want them to know? (Even an incomplete
conclusion moves things along, don't worry about getting it perfect,
good enough is good enough.)
12. Finally, add a line like this as the last line in the extended
description to indicate you are making this copyright contribution to
the project [2]:
"Signed-off-by: Your Name <email-you-use-for-github(a)example.com>:
13. Just above the green "Commit changes" button you can select to
"Create a new branch for this commit and start a pull request". Select
that and click "Commit changes".
14. Fill out the branch name with this format:
"username-chap-name-conclusion-1"
15. Click "Propose Changes:".
16. This takes you to the "Open a pull request page". Fill it out thus:
- Add more comments, if needed.
- Add reviewers, if you want to call out a particular reviewer or
editor. (Optional)
17. Click "Create pull request".
18. Congrats! Your pull request was made successfully, one of us will
review it soonest. You can now go back to step 1 and check the
Conclusion for the next chapter in the list.
[1] Format of any file
ishttps://github.com/theopensourceway/guidebook/blob/master/some_name.adoc
[2] This is commonly the shorthand for invoking the "Developer
Certificate of Origin" or DCO, which I think we want with our project
but haven't implemented yet.
https://developercertificate.org/
https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin
--
Karsten Wade [he/him/his]| Senior Community Architect | @quaid
Red Hat Open Source Program Office (OSPO) : @redhatopen
https://community.redhat.com | https://next.redhat.com | https://osci.io
https://theopensourceway.org | https://github.com/theopensourceway/guide