From 1da17db7172a87532e394b767cb44a7b5660181e Mon Sep 17 00:00:00 2001 From: Omar Assadi Date: Sat, 28 Oct 2017 11:22:44 -0400 Subject: [PATCH] Fix Various Grammar Issues and Adjust Unnatural Wording (#2737) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fix Comma Splices Replace comma splices with more fitting punctuation—usually semicolons. Signed-off-by: Omar Assadi * Turn Some Conjunctions into Sentences Turn conjunctions—which are capable of standing on their own—into their standalone sentences. Signed-off-by: Omar Assadi * 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 --- CONTRIBUTING.md | 57 ++++++++++++++++----------------- README.md | 14 ++++---- options/locale/locale_en-US.ini | 32 +++++++++--------- 3 files changed, 50 insertions(+), 53 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9eb080baa..88a251d362 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,8 +38,8 @@ 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, the faster we can fix the issue. Check out [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html). @@ -48,15 +48,10 @@ getting free help. ## Discuss your design -The project welcomes submissions but please let everyone know what -you're working on if you want to change or add something to the Gitea -repositories. - -Before starting to write something new for the Gitea project, please [file -an issue](https://github.com/go-gitea/gitea/issues/new). Significant -changes must go through the [change proposal -process](https://github.com/go-gitea/proposals) before they can be -accepted. +The project welcomes submissions. If you want to change or add something, +please let everyone know what you're working on—[file an issue](https://github.com/go-gitea/gitea/issues/new)! +Significant changes must go through the [change proposal process](https://github.com/go-gitea/proposals) +before they can be accepted. This process gives everyone a chance to validate the design, helps 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 running the test suite exactly like we do, you should install the CLI for [Drone CI](https://github.com/drone/drone), as we are using the server for continous testing, following [these -instructions](http://readme.drone.io/usage/getting-started-cli). After -that you can simply call `drone exec` within your working directory and -it will try to run the test suite locally. +instructions](http://readme.drone.io/usage/getting-started-cli). After that, +you can simply call `drone exec` within your working directory and it will try +to run the test suite locally. ## Vendoring @@ -109,13 +104,13 @@ An exception are the tools to build the CSS and images. ## Code review -Changes to Gitea must be reviewed before they are accepted, no matter who -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 +pull request workflow to do that. And, we also use [LGTM](http://lgtm.co) to ensure every PR is reviewed by at least 2 maintainers. -Please try to make your pull request easy to review for us. -Please read the [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/devel/faster_reviews.md) guide, +Please try to make your pull request easy to review for us. And, please read +the *[How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/devel/faster_reviews.md)* guide; it has lots of useful tips for any project you may want to contribute. Some of the key points: @@ -146,7 +141,7 @@ import ( ) ``` -## Sign your work +## Sign-off your work The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise @@ -158,9 +153,9 @@ to every git commit message: Signed-off-by: Joe Smith ``` -Please use your real name, we really dislike pseudonyms or anonymous +Please use your real name; we really dislike pseudonyms or anonymous 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 commit automatically with `git commit -s`. ## Release Cycle @@ -170,18 +165,20 @@ on, finishing, and issuing releases. The overall goal is to make a minor release every two months, which breaks down into one month of general development followed by one month of testing and polishing known as the release freeze. All the feature pull requests should be -merged in the first month of one release period and during the frozen -period a corresponding release branch is open for fix backported from -master. Release candidate are made along this period for user testing to +merged in the first month of one release period. And, during the frozen +period, a corresponding release branch is open for fixes backported from +master. Release candidates are made during this period for user testing to obtain a final version that is maintained in this branch. A release is maintained by issuing patch releases to only correct critical problems such as crashes or security issues. -The current release cycle is aligned to start on December 25 to February -24, next is February 25 to April 24, and etc. On this cycle, we also -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. They always begin on the 25th and end on +the 24th (i.e., the 25th of December to February 24th). + +During a development cycle, we may also publish any necessary minor releases +for the previous version. For example, if the latest, published release is +v1.2, then minor changes for the previous release—e.g., v1.1.0 -> v1.1.1—are +still possible. ## Maintainers diff --git a/README.md b/README.md index f43e7ec5c6..73c36b2550 100644 --- a/README.md +++ b/README.md @@ -33,17 +33,17 @@ This project has been ## Notes 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.** -2. If you found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks! +2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks! 3. If you're interested in using our APIs, we have experimental support with [documentation](https://godoc.org/code.gitea.io/sdk/gitea). ## Docs -For more information and instructions about how to install Gitea -please look at our [documentation](https://docs.gitea.io/en-us/). -If you cannot find some specific information, then head over to -our [Discord server](https://discord.gg/NsatcWJ) -or [Matrix room](https://matrix.to/#/#gitea:matrix.org) to chat with us -or use the [forum](https://discourse.gitea.io/). +For more information and instructions about how to install Gitea, please look +at our [documentation](https://docs.gitea.io/en-us/). If you have questions +that are not covered by the documentation, you can get in contact with us on +our [Discord server](https://discord.gg/NsatcWJ), +[Matrix room](https://matrix.to/#/#gitea:matrix.org), +or [forum](https://discourse.gitea.io/)! ## Contributing diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index 2714d93209..86b64946c2 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -9,7 +9,7 @@ sign_in_with = Sign in with sign_out = Sign Out sign_up = Sign Up link_account = Link Account -link_account_signin_or_signup = Login with existing credentials to link your existing account to this account, or sign up for a new one +link_account_signin_or_signup = Login with existing credentials to link your existing account to this account. Or, sign up for a new one register = Register website = Website version = Version @@ -91,7 +91,7 @@ run_user_helper = The user must have access to Repository Root Path and run Gite domain = Domain domain_helper = This affects SSH clone URLs. ssh_port = SSH Port -ssh_port_helper = Port number which your SSH server is using, leave it empty to disable. +ssh_port_helper = Port number which your SSH server is using. Leave it empty to disable. http_port = HTTP Port http_port_helper = Port number which application will listen on. app_url = Application URL @@ -116,7 +116,7 @@ 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." openid_signin = Enable OpenID Sign-In openid_signin_popup = Enable user login via OpenID openid_signup = Enable OpenID Self-registration @@ -124,7 +124,7 @@ openid_signup_popup = Enable OpenID based Self-registration enable_captcha = Enable Captcha enable_captcha_popup = Require a CAPTCHA for user self-registration. require_sign_in_view = Enable Require Sign In to View Pages -require_sign_in_view_popup = Only signed in users can view pages, visitors will only be able to see sign in/up pages. +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." 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. admin_title = Admin Account Settings admin_name = Username @@ -139,7 +139,7 @@ invalid_repo_path = Repository root path is invalid: %v run_user_not_match = Run user is not the current user: %s -> %s save_config_failed = Failed to save configuration: %v invalid_admin_setting = Admin account setting is invalid: %v -install_success = Welcome! Thank you for choosing Gitea, have fun and take care. +install_success = Welcome! Thank you for choosing Gitea. Have fun. And, take care! invalid_log_root_path = Log root path is invalid: %v default_keep_email_private = Default Value for Keep Email Private 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. invalid_ssh_key = Sorry, we were not able to verify your SSH key: %s invalid_gpg_key = Sorry, we were not able to verify your GPG key: %s -unable_verify_ssh_key = The ssh key could not be verified, please double-check it for any mistakes. +unable_verify_ssh_key = "The ssh key could not be verified; please double-check it for any mistakes." auth_failed = Authentication failed: %v -still_own_repo = Your account still has ownership of at least one repository, you need to delete or transfer them first. -still_has_org = Your account still is still a member of least one organization, you need to leave them first. -org_still_own_repo = This organization still owns repositories, you need to delete or transfer them first. +still_own_repo = "Your account still has ownership of at least one repository; you need to delete or transfer them first." +still_has_org = "Your account still is still a member of least one organization; you need to leave them first." +org_still_own_repo = "This organization still owns repositories; you need to delete or transfer them first." target_branch_not_exist = Target branch does not exist. @@ -451,7 +451,7 @@ orgs_none = You are not a member of any organizations. repos_none = You do not own any repositories delete_account = Delete Your Account -delete_prompt = The operation will delete your account permanently, and CANNOT be undone! +delete_prompt = The operation will delete your account permanently. And, this CANNOT be undone! confirm_delete_account = Confirm Deletion delete_account_title = Account Deletion delete_account_desc = Are you sure you want to permanently delete this account? @@ -501,7 +501,7 @@ migrate.clone_address = Clone Address migrate.clone_address_desc = This can be a HTTP/HTTPS/GIT URL migrate.clone_local_path = or local server path migrate.permission_denied = You are not allowed to import local repositories. -migrate.invalid_local_path = Invalid local path, it does not exist or not a directory. +migrate.invalid_local_path = "Invalid local path; it does not exist or is not a directory." migrate.failed = Migration failed: %v migrate.lfs_mirror_unsupported = Mirroring LFS objects is not supported - use 'git lfs fetch --all' and 'git lfs push --all' instead. @@ -747,7 +747,7 @@ pulls.reopen_to_merge = Please reopen this pull request to perform a merge. pulls.merged = Merged pulls.has_merged = This pull request has been merged successfully. pulls.data_broken = Data of this pull request has been broken due to deletion of fork information. -pulls.is_checking = The conflict checking is still in progress, please refresh page in few moments. +pulls.is_checking = "The conflict checking is still in progress; please refresh page in few moments." pulls.can_auto_merge_desc = This pull request can be merged automatically. pulls.cannot_auto_merge_desc = This pull request cannot be merged automatically because there are conflicts. pulls.cannot_auto_merge_helper = Please merge manually in order to resolve the conflicts. @@ -767,7 +767,7 @@ milestones.title = Title milestones.desc = Description milestones.due_date = Due Date (optional) milestones.clear = Clear -milestones.invalid_due_date_format = Due date format is invalid, must be 'yyyy-mm-dd'. +milestones.invalid_due_date_format = "Due date format is invalid; must be 'yyyy-mm-dd'." milestones.create_success = Milestone '%s' has been created successfully! milestones.edit = Edit Milestone milestones.edit_subheader = Use a good description for milestones so people won't be confused. @@ -938,7 +938,7 @@ settings.webhook.response = Response settings.webhook.headers = Headers settings.webhook.payload = Payload settings.webhook.body = Body -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. +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." settings.githook_edit_desc = If the hook is inactive, sample content will be presented. Leaving content to an empty value will disable this hook. settings.githook_name = Hook Name settings.githook_content = Hook Content @@ -1117,7 +1117,7 @@ settings.change_orgname_prompt = This change will change the links to the organi settings.update_avatar_success = The organization avatar has been updated. settings.delete = Delete Organization settings.delete_account = Delete This Organization -settings.delete_prompt = The organization will be permanently removed, and this CANNOT be undone! +settings.delete_prompt = The organization will be permanently removed. And, this CANNOT be undone! settings.confirm_delete_account = Confirm Deletion settings.delete_org_title = Organization Deletion 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 teams.search_repo_placeholder = Search repository... teams.add_team_repository = Add Team Repository teams.remove_repo = Remove -teams.add_nonexistent_repo = The repository you're trying to add does not exist, please create it first. +teams.add_nonexistent_repo = "The repository you're trying to add does not exist; please create it first." [admin] dashboard = Dashboard