Skip to content

Commit 1da17db

Browse files
OmarAssadilafriks
authored andcommitted
Fix Various Grammar Issues and Adjust Unnatural Wording (#2737)
* Fix Comma Splices Replace comma splices with more fitting punctuation—usually semicolons. Signed-off-by: Omar Assadi <[email protected]> * Turn Some Conjunctions into Sentences 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 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]>
1 parent 5866eb2 commit 1da17db

File tree

3 files changed

+50
-53
lines changed

3 files changed

+50
-53
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ and answer the questions so we can understand and reproduce the
3838
problematic behavior.
3939

4040
To show us that the issue you are having is in Gitea itself, please
41-
write clear, concise instructions so we can reproduce the behavior
42-
(even if it seems obvious). The more detailed and specific you are,
41+
write clear, concise instructions so we can reproduce the behavior
42+
even if it seems obvious. The more detailed and specific you are,
4343
the faster we can fix the issue. Check out [How to Report Bugs
4444
Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
4545

@@ -48,15 +48,10 @@ getting free help.
4848

4949
## Discuss your design
5050

51-
The project welcomes submissions but please let everyone know what
52-
you're working on if you want to change or add something to the Gitea
53-
repositories.
54-
55-
Before starting to write something new for the Gitea project, please [file
56-
an issue](https://github.com/go-gitea/gitea/issues/new). Significant
57-
changes must go through the [change proposal
58-
process](https://github.com/go-gitea/proposals) before they can be
59-
accepted.
51+
The project welcomes submissions. If you want to change or add something,
52+
please let everyone know what you're working on—[file an issue](https://github.com/go-gitea/gitea/issues/new)!
53+
Significant changes must go through the [change proposal process](https://github.com/go-gitea/proposals)
54+
before they can be accepted.
6055

6156
This process gives everyone a chance to validate the design, helps
6257
prevent duplication of effort, and ensures that the idea fits inside
@@ -72,9 +67,9 @@ and keep the compatibility on upgrade. To make sure you are
7267
running the test suite exactly like we do, you should install
7368
the CLI for [Drone CI](https://github.com/drone/drone), as
7469
we are using the server for continous testing, following [these
75-
instructions](http://readme.drone.io/usage/getting-started-cli). After
76-
that you can simply call `drone exec` within your working directory and
77-
it will try to run the test suite locally.
70+
instructions](http://readme.drone.io/usage/getting-started-cli). After that,
71+
you can simply call `drone exec` within your working directory and it will try
72+
to run the test suite locally.
7873

7974
## Vendoring
8075

@@ -109,13 +104,13 @@ An exception are the tools to build the CSS and images.
109104

110105
## Code review
111106

112-
Changes to Gitea must be reviewed before they are accepted, no matter who
113-
makes the change even if it is an owner or a maintainer. We use GitHub's
114-
pull request workflow to do that and we also use [LGTM](http://lgtm.co)
107+
Changes to Gitea must be reviewed before they are acceptedno matter who
108+
makes the change, even if they are an owner or a maintainer. We use GitHub's
109+
pull request workflow to do that. And, we also use [LGTM](http://lgtm.co)
115110
to ensure every PR is reviewed by at least 2 maintainers.
116111

117-
Please try to make your pull request easy to review for us.
118-
Please read the [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/devel/faster_reviews.md) guide,
112+
Please try to make your pull request easy to review for us. And, please read
113+
the *[How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/devel/faster_reviews.md)* guide;
119114
it has lots of useful tips for any project you may want to contribute.
120115
Some of the key points:
121116

@@ -146,7 +141,7 @@ import (
146141
)
147142
```
148143

149-
## Sign your work
144+
## Sign-off your work
150145

151146
The sign-off is a simple line at the end of the explanation for the
152147
patch. Your signature certifies that you wrote the patch or otherwise
@@ -158,9 +153,9 @@ to every git commit message:
158153
Signed-off-by: Joe Smith <[email protected]>
159154
```
160155

161-
Please use your real name, we really dislike pseudonyms or anonymous
156+
Please use your real name; we really dislike pseudonyms or anonymous
162157
contributions. We are in the open-source world without secrets. If you
163-
set your `user.name` and `user.email` git configs, you can sign your
158+
set your `user.name` and `user.email` git configs, you can sign-off your
164159
commit automatically with `git commit -s`.
165160

166161
## Release Cycle
@@ -170,18 +165,20 @@ on, finishing, and issuing releases. The overall goal is to make a
170165
minor release every two months, which breaks down into one month of
171166
general development followed by one month of testing and polishing
172167
known as the release freeze. All the feature pull requests should be
173-
merged in the first month of one release period and during the frozen
174-
period a corresponding release branch is open for fix backported from
175-
master. Release candidate are made along this period for user testing to
168+
merged in the first month of one release period. And, during the frozen
169+
period, a corresponding release branch is open for fixes backported from
170+
master. Release candidates are made during this period for user testing to
176171
obtain a final version that is maintained in this branch. A release is
177172
maintained by issuing patch releases to only correct critical problems
178173
such as crashes or security issues.
179174

180-
The current release cycle is aligned to start on December 25 to February
181-
24, next is February 25 to April 24, and etc. On this cycle, we also
182-
maybe publish the previous release minor version. For example, the
183-
current release version is v1.1, but we maybe also publish v1.0.2. When
184-
we publish v1.2, then we will stop publish v1.0.3.
175+
Major release cycles are bimonthly. They always begin on the 25th and end on
176+
the 24th (i.e., the 25th of December to February 24th).
177+
178+
During a development cycle, we may also publish any necessary minor releases
179+
for the previous version. For example, if the latest, published release is
180+
v1.2, then minor changes for the previous release—e.g., v1.1.0 -> v1.1.1—are
181+
still possible.
185182

186183
## Maintainers
187184

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,17 @@ This project has been
3333
## Notes
3434

3535
1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
36-
2. If you found a vulnerability in the project, please write privately to **[email protected]**. Thanks!
36+
2. If you have found a vulnerability in the project, please write privately to **[email protected]**. Thanks!
3737
3. If you're interested in using our APIs, we have experimental support with [documentation](https://godoc.org/code.gitea.io/sdk/gitea).
3838

3939
## Docs
4040

41-
For more information and instructions about how to install Gitea
42-
please look at our [documentation](https://docs.gitea.io/en-us/).
43-
If you cannot find some specific information, then head over to
44-
our [Discord server](https://discord.gg/NsatcWJ)
45-
or [Matrix room](https://matrix.to/#/#gitea:matrix.org) to chat with us
46-
or use the [forum](https://discourse.gitea.io/).
41+
For more information and instructions about how to install Gitea, please look
42+
at our [documentation](https://docs.gitea.io/en-us/). If you have questions
43+
that are not covered by the documentation, you can get in contact with us on
44+
our [Discord server](https://discord.gg/NsatcWJ),
45+
[Matrix room](https://matrix.to/#/#gitea:matrix.org),
46+
or [forum](https://discourse.gitea.io/)!
4747

4848
## Contributing
4949

options/locale/locale_en-US.ini

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sign_in_with = Sign in with
99
sign_out = Sign Out
1010
sign_up = Sign Up
1111
link_account = Link Account
12-
link_account_signin_or_signup = Login with existing credentials to link your existing account to this account, or sign up for a new one
12+
link_account_signin_or_signup = Login with existing credentials to link your existing account to this account. Or, sign up for a new one
1313
register = Register
1414
website = Website
1515
version = Version
@@ -91,7 +91,7 @@ run_user_helper = The user must have access to Repository Root Path and run Gite
9191
domain = Domain
9292
domain_helper = This affects SSH clone URLs.
9393
ssh_port = SSH Port
94-
ssh_port_helper = Port number which your SSH server is using, leave it empty to disable.
94+
ssh_port_helper = Port number which your SSH server is using. Leave it empty to disable.
9595
http_port = HTTP Port
9696
http_port_helper = Port number which application will listen on.
9797
app_url = Application URL
@@ -116,15 +116,15 @@ disable_gravatar_popup = Disable Gravatar and custom sources. All avatars must b
116116
federated_avatar_lookup = Enable Federated Avatars Lookup
117117
federated_avatar_lookup_popup = Enable federated avatar lookup using Libravatar.
118118
disable_registration = Disable Self-registration
119-
disable_registration_popup = Disable user self-registration, only admin can create accounts.
119+
disable_registration_popup = "Disable self-registration; only admins will be able to create accounts."
120120
openid_signin = Enable OpenID Sign-In
121121
openid_signin_popup = Enable user login via OpenID
122122
openid_signup = Enable OpenID Self-registration
123123
openid_signup_popup = Enable OpenID based Self-registration
124124
enable_captcha = Enable Captcha
125125
enable_captcha_popup = Require a CAPTCHA for user self-registration.
126126
require_sign_in_view = Enable Require Sign In to View Pages
127-
require_sign_in_view_popup = Only signed in users can view pages, visitors will only be able to see sign in/up pages.
127+
require_sign_in_view_popup = "Only signed in users can view pages; visitors will only be able to see the sign in and up pages."
128128
admin_setting_desc = You do not need to create an admin account right now. The first user who registers on the site will gain admin access automatically.
129129
admin_title = Admin Account Settings
130130
admin_name = Username
@@ -139,7 +139,7 @@ invalid_repo_path = Repository root path is invalid: %v
139139
run_user_not_match = Run user is not the current user: %s -> %s
140140
save_config_failed = Failed to save configuration: %v
141141
invalid_admin_setting = Admin account setting is invalid: %v
142-
install_success = Welcome! Thank you for choosing Gitea, have fun and take care.
142+
install_success = Welcome! Thank you for choosing Gitea. Have fun. And, take care!
143143
invalid_log_root_path = Log root path is invalid: %v
144144
default_keep_email_private = Default Value for Keep Email Private
145145
default_keep_email_private_popup = This is the default value for the visibility of the user's email address. If set to true the email address of all new users will be hidden until the user changes his setting.
@@ -277,12 +277,12 @@ cannot_add_org_to_team = Organization cannot be added as a team member.
277277
278278
invalid_ssh_key = Sorry, we were not able to verify your SSH key: %s
279279
invalid_gpg_key = Sorry, we were not able to verify your GPG key: %s
280-
unable_verify_ssh_key = The ssh key could not be verified, please double-check it for any mistakes.
280+
unable_verify_ssh_key = "The ssh key could not be verified; please double-check it for any mistakes."
281281
auth_failed = Authentication failed: %v
282282
283-
still_own_repo = Your account still has ownership of at least one repository, you need to delete or transfer them first.
284-
still_has_org = Your account still is still a member of least one organization, you need to leave them first.
285-
org_still_own_repo = This organization still owns repositories, you need to delete or transfer them first.
283+
still_own_repo = "Your account still has ownership of at least one repository; you need to delete or transfer them first."
284+
still_has_org = "Your account still is still a member of least one organization; you need to leave them first."
285+
org_still_own_repo = "This organization still owns repositories; you need to delete or transfer them first."
286286
287287
target_branch_not_exist = Target branch does not exist.
288288
@@ -451,7 +451,7 @@ orgs_none = You are not a member of any organizations.
451451
repos_none = You do not own any repositories
452452

453453
delete_account = Delete Your Account
454-
delete_prompt = The operation will delete your account permanently, and <strong>CANNOT</strong> be undone!
454+
delete_prompt = The operation will delete your account permanently. And, this <strong>CANNOT</strong> be undone!
455455
confirm_delete_account = Confirm Deletion
456456
delete_account_title = Account Deletion
457457
delete_account_desc = Are you sure you want to permanently delete this account?
@@ -501,7 +501,7 @@ migrate.clone_address = Clone Address
501501
migrate.clone_address_desc = This can be a HTTP/HTTPS/GIT URL
502502
migrate.clone_local_path = or local server path
503503
migrate.permission_denied = You are not allowed to import local repositories.
504-
migrate.invalid_local_path = Invalid local path, it does not exist or not a directory.
504+
migrate.invalid_local_path = "Invalid local path; it does not exist or is not a directory."
505505
migrate.failed = Migration failed: %v
506506
migrate.lfs_mirror_unsupported = Mirroring LFS objects is not supported - use 'git lfs fetch --all' and 'git lfs push --all' instead.
507507

@@ -747,7 +747,7 @@ pulls.reopen_to_merge = Please reopen this pull request to perform a merge.
747747
pulls.merged = Merged
748748
pulls.has_merged = This pull request has been merged successfully.
749749
pulls.data_broken = Data of this pull request has been broken due to deletion of fork information.
750-
pulls.is_checking = The conflict checking is still in progress, please refresh page in few moments.
750+
pulls.is_checking = "The conflict checking is still in progress; please refresh page in few moments."
751751
pulls.can_auto_merge_desc = This pull request can be merged automatically.
752752
pulls.cannot_auto_merge_desc = This pull request cannot be merged automatically because there are conflicts.
753753
pulls.cannot_auto_merge_helper = Please merge manually in order to resolve the conflicts.
@@ -767,7 +767,7 @@ milestones.title = Title
767767
milestones.desc = Description
768768
milestones.due_date = Due Date (optional)
769769
milestones.clear = Clear
770-
milestones.invalid_due_date_format = Due date format is invalid, must be 'yyyy-mm-dd'.
770+
milestones.invalid_due_date_format = "Due date format is invalid; must be 'yyyy-mm-dd'."
771771
milestones.create_success = Milestone '%s' has been created successfully!
772772
milestones.edit = Edit Milestone
773773
milestones.edit_subheader = Use a good description for milestones so people won't be confused.
@@ -938,7 +938,7 @@ settings.webhook.response = Response
938938
settings.webhook.headers = Headers
939939
settings.webhook.payload = Payload
940940
settings.webhook.body = Body
941-
settings.githooks_desc = Git Hooks are powered by Git itself, you can edit files of supported hooks in the list below to perform custom operations.
941+
settings.githooks_desc = "Git Hooks are powered by Git itself. You can edit files of supported hooks in the list below to perform custom operations."
942942
settings.githook_edit_desc = If the hook is inactive, sample content will be presented. Leaving content to an empty value will disable this hook.
943943
settings.githook_name = Hook Name
944944
settings.githook_content = Hook Content
@@ -1117,7 +1117,7 @@ settings.change_orgname_prompt = This change will change the links to the organi
11171117
settings.update_avatar_success = The organization avatar has been updated.
11181118
settings.delete = Delete Organization
11191119
settings.delete_account = Delete This Organization
1120-
settings.delete_prompt = The organization will be permanently removed, and this <strong>CANNOT</strong> be undone!
1120+
settings.delete_prompt = The organization will be permanently removed. And, this <strong>CANNOT</strong> be undone!
11211121
settings.confirm_delete_account = Confirm Deletion
11221122
settings.delete_org_title = Organization Deletion
11231123
settings.delete_org_desc = This organization is going to be deleted permanently, are you sure you want to continue?
@@ -1161,7 +1161,7 @@ teams.repositories = Team Repositories
11611161
teams.search_repo_placeholder = Search repository...
11621162
teams.add_team_repository = Add Team Repository
11631163
teams.remove_repo = Remove
1164-
teams.add_nonexistent_repo = The repository you're trying to add does not exist, please create it first.
1164+
teams.add_nonexistent_repo = "The repository you're trying to add does not exist; please create it first."
11651165

11661166
[admin]
11671167
dashboard = Dashboard

0 commit comments

Comments
 (0)