Fix Various Grammar Issues and Adjust Unnatural Wording #2737

OmarAssadi · 2017-10-18T22:39:17Z

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.

codecov-io · 2017-10-18T22:46:36Z

Codecov Report

Merging #2737 into master will increase coverage by 0.04%.
The diff coverage is n/a.

@@            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

Impacted Files	Coverage Δ
models/branches.go	`0% <0%> (-21.6%)`	⬇️
models/notification.go	`58.6% <0%> (-10.76%)`	⬇️
models/user.go	`18.24% <0%> (-3.71%)`	⬇️
models/consistency.go	`93.96% <0%> (-2.59%)`	⬇️
models/ssh_key.go	`10.6% <0%> (ø)`	⬆️
routers/user/profile.go	`0% <0%> (ø)`	⬆️
models/webhook_discord.go	`3.2% <0%> (ø)`	⬆️
models/repo_editor.go	`0% <0%> (ø)`	⬆️
routers/api/v1/misc/swagger.go
models/repo_indexer.go
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5866eb2...9825681. Read the comment docs.

lafriks · 2017-10-19T05:16:56Z

Should be merged after #2056

pgaskin

Thanks for the contribution. Great job other than my comments below.

pgaskin · 2017-10-19T11:54:14Z

CONTRIBUTING.md

-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


No comments should be after the but.

Also, the semicolon is unnecessary

Yeah, a bit of a weird transition on this one. Replaced it with something a bit cleaner.

pgaskin · 2017-10-19T11:55:44Z

CONTRIBUTING.md

-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 should be no dash between change and even, and accepted and no. It is more clear and concise with a comma.

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.

pgaskin

I am almost ready to approve this.

pgaskin · 2017-10-19T13:21:30Z

CONTRIBUTING.md

-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. 


Get rid of the And, , it it not needed. Also, remove the dash before i.e, and surround the example with round brackets.

pgaskin · 2017-10-19T13:46:48Z

LGTM

lunny · 2017-10-20T01:53:17Z

CONTRIBUTING.md

@@ -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,


But we just adjust to 80 columns one line.

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.

@lunny I went ahead and wrapped all of the lines I changed to 80 columns. Should be okay now!

lafriks · 2017-10-21T13:31:58Z

Please rebase and fix conflicts as #2056 was merged

bkcsoft

🎉

bkcsoft · 2017-10-23T22:32:28Z

CONTRIBUTING.md

 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


Signed commits and Sign-offs are different things. https://help.github.com/articles/signing-commits-using-gpg/

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?

Ooh nvm, I though about git commit -S 😅

bkcsoft · 2017-10-23T22:40:26Z

options/locale/locale_en-US.ini

@@ -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.


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.

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't

Anyway, 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.

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 😉

Alright, I'll go ahead and fix those when I'm home (Damn you, INI!) 😉

@bkcsoft Fixed all the issues with the ini file.

lunny · 2017-10-27T04:32:31Z

Please resolve the confilict.

Replace comma splices with more fitting punctuation—usually semicolons. Signed-off-by: Omar Assadi <[email protected]>

Turn conjunctions—which are capable of standing on their own—into their standalone sentences. Signed-off-by: Omar Assadi <[email protected]>

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 <[email protected]>

OmarAssadi · 2017-10-27T14:51:38Z

@lunny Done. Sorry, was a little busy.

bkcsoft · 2017-10-28T15:08:43Z

LGTM

tboerger added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Oct 18, 2017

lafriks added the type/docs This PR mainly updates/creates documentation label Oct 19, 2017

lafriks added this to the 1.3.0 milestone Oct 19, 2017

pgaskin suggested changes Oct 19, 2017

View reviewed changes

tboerger added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Oct 19, 2017

lunny requested changes Oct 20, 2017

View reviewed changes

lunny approved these changes Oct 21, 2017

View reviewed changes

bkcsoft suggested changes Oct 23, 2017

View reviewed changes

Omar Assadi added 3 commits October 27, 2017 10:48

Fix Comma Splices

601451d

Replace comma splices with more fitting punctuation—usually semicolons. Signed-off-by: Omar Assadi <[email protected]>

Turn Some Conjunctions into Sentences

a955918

Turn conjunctions—which are capable of standing on their own—into their standalone sentences. Signed-off-by: Omar Assadi <[email protected]>

Reword Sections and Fix Issues in Docs

9825681

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 <[email protected]>

bkcsoft approved these changes Oct 28, 2017

View reviewed changes

tboerger added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Oct 28, 2017

lafriks merged commit 1da17db into go-gitea:master Oct 28, 2017

go-gitea locked and limited conversation to collaborators Nov 23, 2020

Uh oh!

Fix Various Grammar Issues and Adjust Unnatural Wording #2737

Fix Various Grammar Issues and Adjust Unnatural Wording #2737

Uh oh!

Conversation

OmarAssadi commented Oct 18, 2017

Uh oh!

codecov-io commented Oct 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

lafriks commented Oct 19, 2017

Uh oh!

pgaskin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OmarAssadi Oct 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pgaskin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pgaskin commented Oct 19, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lafriks commented Oct 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bkcsoft left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OmarAssadi Oct 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bkcsoft Oct 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lunny commented Oct 27, 2017

Uh oh!

OmarAssadi commented Oct 27, 2017

Uh oh!

bkcsoft commented Oct 28, 2017

Uh oh!

Uh oh!

codecov-io commented Oct 18, 2017 •

edited

Loading

OmarAssadi Oct 19, 2017 •

edited

Loading

lafriks commented Oct 21, 2017 •

edited

Loading

OmarAssadi Oct 23, 2017 •

edited

Loading

bkcsoft Oct 23, 2017 •

edited

Loading