Skip to content

Commit

Permalink
docs: correct grammar and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
phil-davis authored and fallion committed Nov 25, 2023
1 parent 4b137aa commit cd80da4
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Contributions are most welcome. Please check the [CONTRIBUTING](https://commitsa

## Sponsoring

If you feel like showing even more support for this project you can sponsor it using the Sponsor button on Github. A little help goes a long way when it comes with OSS and it'll help support this project.
If you feel like showing even more support for this project you can sponsor it using the Sponsor button on GitHub. A little help goes a long way when it comes with OSS and it'll help support this project.
2 changes: 1 addition & 1 deletion config/commits.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"github.com/spf13/viper"
)

// CommitConfig will return the RunnerOptions using defaults unless overriden in config or flags
// CommitConfig will return the RunnerOptions using defaults unless overridden in config or flags
func CommitConfig() root_runner.RunnerOptions {
// defaults
strict := true
Expand Down
2 changes: 1 addition & 1 deletion config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const (
CommitsarConfigPath = "COMMITSAR_CONFIG_PATH"
)

// LoadConfig iterrates through possible config paths. No config will be loaded if no files are present.
// LoadConfig iterates through possible config paths. No config will be loaded if no files are present.
func LoadConfig() error {
viper.AutomaticEnv()
viper.SetConfigName(".commitsar")
Expand Down
12 changes: 6 additions & 6 deletions docs/content/configuration/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ title: Configuration File

**Name:** `.commitsar.yml`

In order to make configuration easier than through flags we provide configuration file support. Most up to date examples can be found in <https://github.com/aevea/commitsar/tree/master/config/testdata>.
In order to make configuration easier than through flags we provide configuration file support. Most up-to-date examples can be found in <https://github.com/aevea/commitsar/tree/master/config/testdata>.

By default the current working directory is used to scan for the file. However this can be overriden by specifying `COMMITSAR_CONFIG_PATH` environment variable. Accepts relative or absolute paths.
By default the current working directory is used to scan for the file. However this can be overridden by specifying `COMMITSAR_CONFIG_PATH` environment variable. Accepts relative or absolute paths.

Example: `COMMITSAR_CONFIG_PATH=./testdata` will scan for `.commitsar.yaml` in the `testdata` folder.

Expand Down Expand Up @@ -40,17 +40,17 @@ commits:
| Name | Default Value | Description | Available from |
| -------------- | ------------- | ------------------------------------------------------------------------------------------------------- | -------------- |
| disabled | false | Disables checking commmits. Useful if you want to use commitsar only for PR titles. | v0.14.0 |
| disabled | false | Disables checking commits. Useful if you want to use commitsar only for PR titles. | v0.14.0 |
| strict | true | Enforces strict category enforcement. | v0.14.0 |
| limit | none | Makes commitsar check only the last x commits. Useful if you want to run commitsar on master. | v0.14.0 |
| all | false | Makes commitsar check all the commits in history. **Overrides the `limit` flag** | v0.14.0 |
| limit | none | Makes commitsar check only the last x commits. Useful if you want to run commitsar on master. | v0.14.0 |
| all | false | Makes commitsar check all the commits in history. **Overrides the `limit` flag** | v0.14.0 |
| upstreamBranch | origin/master | Makes commitsar check against specific branch (e.g. use `origin/main` if `main` is your default branch) | v0.17.0 |

## Pull Request style settings

**Pull Request pipeline is still in early stages. Please report any bugs**

#### Convetional style
#### Conventional style

```yaml
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/contributing/filtering.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import Mermaid from "@theme/Mermaid";
### Branch diff

By default commitsar will run git log on the base branch and the branch which is going to get merged and gets a diff of the commit objects.
This allows us to get commits only on the branch iregardless of what was merged from master.
This allows us to get commits only on the branch regardless of what was merged from master.

### Filtering by type

Expand Down
8 changes: 4 additions & 4 deletions docs/content/contributing/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ title: Get started
## Requirements

- [Go](https://golang.org/) (See pinned version in go.mod)
- [git](https://git-scm.com/) (while git is not required to run commitsar it is needed to set up tests)
- [git](https://git-scm.com/) (while git is not required to run commitsar, it is needed to set up tests)

This project also uses [magefiles](https://magefile.org/). To get up and running please run: `go install github.com/magefile/mage`. These allow us to set up templates and cross-platform commands.

## Running tests

Run `mage test`. This will git clone all git bundles and run tests in the entire repo. To run single tests use the VSCode functionality or provide full path to `go test`.
Run `mage test`. This will git clone all git bundles and run tests in the entire repo. To run single tests use the VSCode functionality or provide the full path to `go test`.

## Git bundles

In order to test commitsar against complicated real-life examples we use [git bundles](https://git-scm.com/docs/git-bundle). These can be `git cloned` like real repositories. They allow us to created real history and prevent edge cases that can happen when creating git history using shell (all commits have same timestamp for example).
In order to test commitsar against complicated real-life examples we use [git bundles](https://git-scm.com/docs/git-bundle). These can be `git cloned` like real repositories. They allow us to create real history and prevent edge cases that can happen when creating git history using shell (all commits have the same timestamp, for example).

### Creating a new bundle

Expand All @@ -27,7 +27,7 @@ In order to test commitsar against complicated real-life examples we use [git bu
- once ready run `git bundle create name_of_repo.bundle --all`
- copy the bundle to testdata/

All files outside of .bundle files are ignore in the testdata folder so you don't have to worry about cleanup.
All files outside of .bundle files are ignored in the testdata folder so you don't have to worry about cleanup.

## Commit style

Expand Down
2 changes: 1 addition & 1 deletion docs/content/usage/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ docker run --rm --name="commitsar" -w /src -v "$(pwd)":/src aevea/commitsar
docker run --rm --name="commitsar" -w /src -v "$(pwd)":/src aevea/commitsar ./path-to-repo
```

Make sure to load the working directory where `.git` folder is present. Commitsar will not work without the `.git` folder. This can be overriden by setting the path argument.
Make sure to load the working directory where `.git` folder is present. Commitsar will not work without the `.git` folder. This can be overridden by setting the path argument.

1 comment on commit cd80da4

@vercel
Copy link

@vercel vercel bot commented on cd80da4 Nov 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.