Skip to content

doc: Enhancing guides by fixing and making grammar more consistent #33152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ChrisAHolland wants to merge 5 commits into from
Closed

doc: Enhancing guides by fixing and making grammar more consistent #33152

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be0e882
Enhanced maintaining-openssl.md
ChrisAHolland Apr 29, 2020
0d8dda3
Enhanced collaborator-guide.md
ChrisAHolland Apr 30, 2020
168ecce
Enhanced cpp-style-guide.md
ChrisAHolland Apr 30, 2020
0f2657f
Enhanced cve-management-process.md
ChrisAHolland Apr 30, 2020
226b3a0
Shortened lines for linter
ChrisAHolland Apr 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Shortened lines for linter
  • Loading branch information
@ChrisAHolland
ChrisAHolland committed Apr 30, 2020
commit 226b3a0439119153bb04d79f6b15357184d55cb3
24 changes: 13 additions & 11 deletions doc/guides/collaborator-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ review by @-mention.
See [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker).

If you are the first Collaborator to approve a pull request that has no CI yet,
please [start one](#testing-and-ci). Please also start a new CI if the pull request
creator pushed new code since the last CI run.
please [start one](#testing-and-ci). Please also start a new CI if the
pull request creator pushed new code since the last CI run.

### Consensus Seeking

Expand Down Expand Up @@ -582,7 +582,8 @@ for that commit. This is an opportunity to fix commit messages.
background.
* Required: A `Reviewed-By: Name <email>` line for each Collaborator who
reviewed the change.
* Useful for @mentions / contact list if something goes wrong in the pull request.
* Useful for @mentions / contact list if something goes wrong in the
pull request.
* Protects against the assumption that GitHub will be around forever.

Other changes may have landed on master since the successful CI run. As a
Expand All @@ -597,12 +598,13 @@ $ git rev-list upstream/master...HEAD | xargs core-validate-commit

Optional: For your own commits, force push the amended commit to the pull
request branch. If your branch name is `bugfix`, then: `git push
--force-with-lease origin master:bugfix`. Don't close the pull request. It will close
after you push it upstream. It will have the purple merged status rather than
the red closed status. If you close the pull request before GitHub adjusts its
status, it will show up as a 0 commit pull request with no changed files.
The order of operations is important. If you push upstream before you push to
your branch, GitHub will close the issue with the red closed status.
--force-with-lease origin master:bugfix`. Don't close the pull request.
It will close after you push it upstream. It will have the purple merged
status rather than the red closed status. If you close the pull request
before GitHub adjusts its status, it will show up as a 0 commit pull
request with no changed files. The order of operations is important.
If you push upstream before you push to your branch, GitHub will close
the issue with the red closed status.

Time to push it:

Expand Down Expand Up @@ -699,8 +701,8 @@ land on the staging branches, the backporter removes the `lts-watch-` label.
Likewise, as commits land in an LTS release, the releaser removes the `land-on-`
label.

Attach the appropriate `lts-watch-` label to any pull request that may impact an LTS
release.
Attach the appropriate `lts-watch-` label to any pull request that
may impact an LTS release.

## Who to CC in the issue tracker

Expand Down
6 changes: 4 additions & 2 deletions doc/guides/maintaining-openssl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ them.
% git commit openssl
````

The commit message can be written as (with the openssl version set to the relevant value):
The commit message can be written as (with the openssl version set
to the relevant value):
```text
deps: upgrade openssl sources to 1.1.0h

Expand Down Expand Up @@ -88,7 +89,8 @@ files if they are changed before committing:
% git commit
```

The commit message can be written as (with the openssl version set to the relevant value):
The commit message can be written as (with the openssl version set
to the relevant value):
```text
deps: update archs files for OpenSSL-1.1.0

Expand Down