Sfoglia il codice sorgente

Merge pull request #125 from ziyaddin/patch-1

Fix typos in docs
Zachary Rice 7 anni fa
parent
commit
c869812875
3 ha cambiato i file con 11 aggiunte e 11 eliminazioni
  1. 4 4
      CHANGELOG.md
  2. 3 3
      CONTRIBUTING.md
  3. 4 4
      README.md

+ 4 - 4
CHANGELOG.md

@@ -72,14 +72,14 @@ CHANGELOG
 
 
 1.6.0
 1.6.0
 -----
 -----
-- Default maximum goroutines spawned is number of cores your cpu run with. See benchmarks in wiki.
-- Cleanup after each repo audit for organizations rather than waiting for the entire organization to complete. Eliminates risk of running out of disk space.
+- Default maximum goroutines spawned is number of cores your CPU run with. See benchmarks in wiki.
+- Cleanup after each repo audit for organizations rather than waiting for the entire organization to complete. Eliminates the risk of running out of disk space.
 
 
 
 
 1.5.0
 1.5.0
 -----
 -----
 - Support for CSV reporting
 - Support for CSV reporting
-- Refactoring github user/owner audits
+- Refactoring Github user/owner audits
 
 
 1.4.0
 1.4.0
 -----
 -----
@@ -96,7 +96,7 @@ CHANGELOG
 
 
 1.2.0
 1.2.0
 -----
 -----
-- Added support for providing an alternate GitHub URL to support scanning GitHub Enteprise repositories
+- Added support for providing an alternate GitHub URL to support scanning GitHub Enterprise repositories
 
 
 1.1.2
 1.1.2
 -----
 -----

+ 3 - 3
CONTRIBUTING.md

@@ -5,14 +5,14 @@ contributions via GitHub pull requests.
 
 
 ## How to Contribute
 ## How to Contribute
 
 
-Open a PR. Give the PR a descriptive title. Add some comments describing whats the purpose of the PR.
+Open a PR. Give the PR a descriptive title. Add some comments describing what is the purpose of the PR.
 
 
 __BUT before you do that!__
 __BUT before you do that!__
 
 
 Make sure you pass this list of requirements.
 Make sure you pass this list of requirements.
 
 
-- You've ran `go fmt`.
-- You've ran `golint`.
+- You've run `go fmt`.
+- You've run `golint`.
 - Your Go changes are confined to `gitleaks_test.go` and `main.go`. This is subject to change as the project evolves. Stylistically, I like having a single go file considering the size of this project (its tiny).
 - Your Go changes are confined to `gitleaks_test.go` and `main.go`. This is subject to change as the project evolves. Stylistically, I like having a single go file considering the size of this project (its tiny).
 - You've added test cases for your changes.
 - You've added test cases for your changes.
 - You've updated [the changelog](CHANGELOG.md).
 - You've updated [the changelog](CHANGELOG.md).

+ 4 - 4
README.md

@@ -93,7 +93,7 @@ Help Options:
 ```
 ```
 
 
 #### Exit Codes
 #### Exit Codes
-Gitleaks provides consisten exist codes to assist in automation workflows such as CICD platforms and bulk scanning.
+Gitleaks provides consistent exist codes to assist in automation workflows such as CICD platforms and bulk scanning.
 
 
 These can be effectively used in conjunction with the report output file to detect and return meaningful data back to the user or external system about if leaks have been detected, and where they reside.
 These can be effectively used in conjunction with the report output file to detect and return meaningful data back to the user or external system about if leaks have been detected, and where they reside.
 
 
@@ -113,10 +113,10 @@ The code return codes are:
     * [Rewrite git history with the BFG (theguardian.com)](https://www.theguardian.com/info/developer-blog/2013/apr/29/rewrite-git-history-with-the-bfg)
     * [Rewrite git history with the BFG (theguardian.com)](https://www.theguardian.com/info/developer-blog/2013/apr/29/rewrite-git-history-with-the-bfg)
 * [Auditing Bitbucket Server Data for Credentials in AWS (sourcedgroup.com)](https://www.sourcedgroup.com/blog/auditing-bitbucket-server-data-credentials-in-aws)
 * [Auditing Bitbucket Server Data for Credentials in AWS (sourcedgroup.com)](https://www.sourcedgroup.com/blog/auditing-bitbucket-server-data-credentials-in-aws)
 
 
-    This blog post details how gitleaks was used to audit data in Atlassian Bitbucket server when hosted on AWS, and visualise the results in a compliance dashboard using Splunk.
+    This blog post details how gitleaks was used to audit data in Atlassian Bitbucket server when hosted on AWS and visualise the results in a compliance dashboard using Splunk.
 
 
-* How does gitleaks differ to github token scanning ?
-    * [Github recently announced](https://blog.github.com/2018-10-16-future-of-software/#github-token-scanning-for-public-repositories-public-beta) a new capbility to their cloud platform that detects exposed credentials for a number of common services and platforms and automatically notifies the provider for revocation or similar action. Gitleaks provides a similar detection capability for non-github cloud users, in which repositories can be easily audited and results provided in a number of formats.
+* How does gitleaks differ to Github token scanning?
+    * [Github recently announced](https://blog.github.com/2018-10-16-future-of-software/#github-token-scanning-for-public-repositories-public-beta) a new capability to their cloud platform that detects exposed credentials for a number of common services and platforms and automatically notifies the provider for revocation or similar action. Gitleaks provides a similar detection capability for non-Github cloud users, in which repositories can be easily audited and results provided in a number of formats.