Fix Various Grammar Issues and Adjust Unnatural Wording #2737
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2737 +/- ##
==========================================
+ Coverage 26.86% 26.91% +0.04%
==========================================
Files 89 87 -2
Lines 17596 17286 -310
==========================================
- Hits 4727 4652 -75
+ Misses 12183 11955 -228
+ Partials 686 679 -7
Continue to review full report at Codecov.
|
tboerger
added
the
lgtm/need 2
|
Should be merged after #2056 |
CONTRIBUTING.md
Outdated
| repositories. | ||
|
|
||
| Before starting to write something new for the Gitea project, please [file | ||
| The project welcomes submissions. But, if you want to change or add something to the Gitea repositories, please let everyone know what you're working on; before starting to write something new, [file |
There was a problem hiding this comment.
No comments should be after the but.
There was a problem hiding this comment.
Also, the semicolon is unnecessary
There was a problem hiding this comment.
Yeah, a bit of a weird transition on this one. Replaced it with something a bit cleaner.
CONTRIBUTING.md
Outdated
| makes the change even if it is an owner or a maintainer. We use GitHub's | ||
| pull request workflow to do that and we also use [LGTM](http://lgtm.co) | ||
| Changes to Gitea must be reviewed before they are accepted—no matter who | ||
| makes the change—even if they are an owner or a maintainer. We use GitHub's |
There was a problem hiding this comment.
There should be no dash between change and even, and accepted and no. It is more clear and concise with a comma.
There was a problem hiding this comment.
Whoops! Great catch! Seems to be a section that I started touching and didn't get to finish. Yeah, I'll go ahead and change that.
CONTRIBUTING.md
Outdated
| maybe publish the previous release minor version. For example, the | ||
| current release version is v1.1, but we maybe also publish v1.0.2. When | ||
| we publish v1.2, then we will stop publish v1.0.3. | ||
| Major release cycles are bimonthly. And, they always begin on the 25th and end on the 24th—i.e., the 25th of December to February 24th. |
There was a problem hiding this comment.
Get rid of the And, , it it not needed. Also, remove the dash before i.e, and surround the example with round brackets.
|
LGTM |
tboerger
added
lgtm/need 1
CONTRIBUTING.md
Outdated
| @@ -38,8 +38,7 @@ and answer the questions so we can understand and reproduce the | |||
| problematic behavior. | |||
|
|
|||
| To show us that the issue you are having is in Gitea itself, please | |||
| write clear, concise instructions so we can reproduce the behavior | |||
| (even if it seems obvious). The more detailed and specific you are, | |||
| write clear, concise instructions so we can reproduce the behavior—even if it seems obvious. The more detailed and specific you are, | |||
There was a problem hiding this comment.
But we just adjust to 80 columns one line.
There was a problem hiding this comment.
Ah, okay. Yeah, I noticed some portions of the file have manual breaks and some portions don't. I'll go ahead and change that.
Might be worth adding that to the guidelines in the future, too—unless I missed it.
There was a problem hiding this comment.
@lunny I went ahead and wrapped all of the lines I changed to 80 columns. Should be okay now!
|
Please rebase and fix conflicts as #2056 was merged |
| contributions. We are in the open-source world without secrets. If you | ||
| set your `user.name` and `user.email` git configs, you can sign your | ||
| set your `user.name` and `user.email` git configs, you can sign-off your |
There was a problem hiding this comment.
Signed commits and Sign-offs are different things. https://help.github.com/articles/signing-commits-using-gpg/
There was a problem hiding this comment.
I am aware; that's why I modified that section. It seems to me that it is referring to sign-offs and not actual PGP signings. Here is the full section for context. It never mentions PGP keys. But, it does give an example of using the standard git sign-off.
Maybe I missed something, though 😉
EDIT: Ah, yeah, it also uses the lowercase -s flag—which is used for a sign-off and not a PGP signed commit (-S). Maybe that section header should also be changed from "Sign your work" so that it is less confusing?
There was a problem hiding this comment.
Ooh nvm, I though about git commit -S 😅
options/locale/locale_en-US.ini
Outdated
| @@ -116,15 +116,15 @@ disable_gravatar_popup = Disable Gravatar and custom sources. All avatars must b | |||
| federated_avatar_lookup = Enable Federated Avatars Lookup | |||
| federated_avatar_lookup_popup = Enable federated avatar lookup using Libravatar. | |||
| disable_registration = Disable Self-registration | |||
| disable_registration_popup = Disable user self-registration, only admin can create accounts. | |||
| disable_registration_popup = Disable self-registration; only admins will be able to create accounts. | |||
There was a problem hiding this comment.
Since this is an ini-file, ; delimits a comment and the entire string would need to be quoted like so:
foo = "Bar; baz"Second thought on this is that semi-colon is slightly confusing to non-native speakers. Who either use English out of preference (like myself), or there simply not being a translation for their language yet.
There was a problem hiding this comment.
Ah, yeah, nice catch on the comment delimiter! Does the particular ini implementation used by Gitea consider those as comments? The Wikipedia page on ini files and most parsers I have used typically only consider them comments if the semicolon is the first character on a line.
; this would normally be a comment
key = value; but this wouldn'tAnyway, I'll double check and adjust those in a little if necessary. Thanks!
Second thought on this is that semi-colon is slightly confusing to non-native speakers.
Maybe you have an alternative suggestion? I can see where you're coming from. But, I just think that for these existing comma splices, if you don't rewrite the actual sentences themselves, semicolons are the best punctuation mark to use as they let you know that these are two sentences that can and do stand on their own but are also heavily related to each other—which is exactly the intended purpose of these misused commas.
There was a problem hiding this comment.
- We use
go-ini/ini, and yes it does. https://github.com/go-ini/ini/#comment - Harder to answer. For now I think we can use semicolons since they're not used that often, and people will probably just think it's a type-o
Edit: They still have to be quoted though 😉
There was a problem hiding this comment.
Alright, I'll go ahead and fix those when I'm home (Damn you, INI!) 😉
There was a problem hiding this comment.
@bkcsoft Fixed all the issues with the ini file.
|
Please resolve the confilict. |
Replace comma splices with more fitting punctuation—usually semicolons. Signed-off-by: Omar Assadi <omar@assadi.ru>
Turn conjunctions—which are capable of standing on their own—into their standalone sentences. Signed-off-by: Omar Assadi <omar@assadi.ru>
Reword sections of the contributing docs and readme file to be more natural and clear. Additionally, fix the majority of the grammar mistakes. Signed-off-by: Omar Assadi <omar@assadi.co.il>
|
@lunny Done. Sorry, was a little busy. |
|
LGTM |
tboerger
added
lgtm/done
Hi!
This pull request fixes a number of different grammar issues—primarily comma splices, run on sentences, and missing punctuation. Additionally, it includes some very minor adjustments in the English README and contributing guidelines.
Best regards,
Omar.