Skip to content

Commit 37c9ccf

Browse files
robinsmith-sourcekrlvi
authored andcommitted
fix(docs): clean up some typos in documentation files
1 parent dd50492 commit 37c9ccf

File tree

3 files changed

+15
-17
lines changed

3 files changed

+15
-17
lines changed

CONTRIBUTING.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ So you're interested in contributing to GitButler. Amazing!
55
## Understand the License
66

77
First thing to know, GitButler is not a side project, it is the product of a
8-
pretty cool company located in Berlin who develop this client and it's
8+
pretty cool company located in Berlin who develop this client and its
99
associated services professionally. For this reason, we have licensed this
1010
software under the [Functional Source License](https://fsl.software/), a
1111
mostly permissive non-compete license that converts to Apache 2.0 or MIT after
@@ -24,13 +24,13 @@ As a private company, we have our own development processes that we try to be
2424
fairly open about, but we're all sitting in a room in Berlin, so external
2525
contributions and remote work aren't really a central part of our process.
2626

27-
It's possible that you want to see a feature and we disagree, so if you want
28-
to get something accepted, please discuss it with us first so we can all be
27+
It's possible that you want to see a feature, and we disagree, so if you want
28+
to get something accepted, please discuss it with us first, so we can all be
2929
fairly confident that your work has a chance to be accepted before you spend
3030
your time or result in needing to maintain a fork.
3131

3232
The two places to communicate with us are on Discord and GitHub (issues and
33-
discussions, etc).
33+
discussions, etc.).
3434

3535
Join our Discord here: https://discord.gg/MmFkmaJ42D
3636

@@ -44,26 +44,26 @@ maintaining this project.
4444

4545
## Submitting a Change
4646

47-
If you talked it over with us and we agree that it's something we would take,
47+
If you talked it over with us, and we agree that it's something we would take,
4848
please do the familiar GitHub dance of forking the repository and submitting
49-
a Pull Request so we can review and possibly merge it.
49+
a Pull Request, so we can review and possibly merge it.
5050

5151
Any contributions sent to us implicitly give us the right to redistribute that
5252
work under the same license and rights.
5353

54-
[Why we don't explicity require a CLA for contributions to GitButler](https://ben.balter.com/2018/01/02/why-you-probably-shouldnt-add-a-cla-to-your-open-source-project/)
54+
[Why we don't explicitly require a CLA for contributions to GitButler](https://ben.balter.com/2018/01/02/why-you-probably-shouldnt-add-a-cla-to-your-open-source-project/)
5555

5656
## How will GitButler Stay in Business?
5757

5858
The client is open source and free to use, forever. If you want to use this
5959
as your Git client, it will never be pulled out from under you.
6060

6161
In parallel with this client, we're also developing some rad cloud services
62-
that you can optionally enable but are not neccesary or limiting to your
62+
that you can optionally enable but are not necessary or limiting to your
6363
client experience. If we can provide some compelling team functionality that
6464
you can get your boss to pay for, then we would love to have your business
6565
in that area. If it's not interesting to you, then never fear, the client is
66-
fully functional on it's own and totally free.
66+
fully functional on its own and totally free.
6767

6868
## Kudos
6969

@@ -73,7 +73,7 @@ care about what we're doing.
7373

7474
However, helping us with our codebase is over the top. We'll call out our
7575
contributors in some way, though we haven't quite figured out how yet. But
76-
rest assured, we'll give you credit. Or schwag maybe. Or a beer, if you're
76+
rest assured, we'll give you credit. Or schwag, maybe. Or a beer, if you're
7777
ever in town.
7878

7979
## Get into the Code!

DEVELOPMENT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ You'll need to fix the security permissions for the `nodejs` folder.
140140
> Node.js, this may pose a security concern. Be sure to understand
141141
> the implications of this before proceeding.
142142
143-
1. Right click on the `nodejs` folder in `Program Files`.
143+
1. Right-click on the `nodejs` folder in `Program Files`.
144144
2. Click on `Properties`.
145145
3. Click on the `Security` tab.
146146
4. Click on `Edit` next to "change permissions".

README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
<p align="center">
2-
<p align="center">
3-
<img width="128px" src="gitbutler-app/icons/[email protected]" />
4-
</p>
1+
<div align="center">
2+
<img align="center" width="128px" src="gitbutler-app/icons/[email protected]" />
53
<h1 align="center"><b>GitButler</b></h1>
64
<p align="center">
75
Git branch management tool, built from the ground up for modern workflows
@@ -17,7 +15,7 @@
1715
<br />
1816
<i>~ Link for Windows will be added once a release is available. ~</i>
1917
</p>
20-
</p>
18+
</div>
2119

2220
<br/>
2321

@@ -115,7 +113,7 @@ or [join our Discord server](https://discord.gg/wDKZCPEjXC).
115113

116114
Commit message generation is an opt-in feature. You can enable it while adding your repository for the first time or later in the project settings.
117115

118-
Currently GitButler uses OpenAI's API for diff summarization, which means that if enabled, code diffs would be sent to OpenAI's servers.
116+
Currently, GitButler uses OpenAI's API for diff summarization, which means that if enabled, code diffs would be sent to OpenAI's servers.
119117

120118
Our goal is to make this feature more modular such that in the future you can modify the prompt as well as plug a different LLM endpoints (including a local ones).
121119

0 commit comments

Comments
 (0)