Skip to content

Commit 4ca6c06

Browse files
authored
Merge pull request #817 from dschaller/patch-1
docs: minor updates to getting started docs
2 parents 865751e + d5be909 commit 4ca6c06

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

GETTING_STARTED.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Getting started
22
Before you start, you should understand the concept of forward/up and reverse/down database migrations.
33

4-
Configure a database for your application. Make sure that your database driver is supported [here](README.md#databases)
4+
Configure a database for your application. Make sure that your database driver is supported [here](README.md#databases).
55

66
## Create migrations
77
Create some migrations using migrate CLI. Here is an example:
@@ -10,7 +10,7 @@ migrate create -ext sql -dir db/migrations -seq create_users_table
1010
```
1111
Once you create your files, you should fill them.
1212

13-
**IMPORTANT:** In a project developed by more than one person there is a chance of migrations inconsistency - e.g. two developers can create conflicting migrations, and the developer that created his migration later gets it merged to the repository first.
13+
**IMPORTANT:** In a project developed by more than one person there is a chance of migrations inconsistency - e.g. two developers can create conflicting migrations, and the developer that created their migration later gets it merged to the repository first.
1414
Developers and Teams should keep an eye on such cases (especially during code review).
1515
[Here](https://github.com/golang-migrate/migrate/issues/179#issuecomment-475821264) is the issue summary if you would like to read more.
1616

@@ -30,7 +30,7 @@ Just add the code to your app and you're ready to go!
3030

3131
Before commiting your migrations you should run your migrations up, down, and then up again to see if migrations are working properly both ways.
3232
(e.g. if you created a table in a migration but reverse migration did not delete it, you will encounter an error when running the forward migration again)
33-
It's also worth checking your migrations in a separate, containerized environment. You can find some tools in the end of this document.
33+
It's also worth checking your migrations in a separate, containerized environment. You can find some tools at the [end of this document](#further-reading).
3434

3535
**IMPORTANT:** If you would like to run multiple instances of your app on different machines be sure to use a database that supports locking when running migrations. Otherwise you may encounter issues.
3636

0 commit comments

Comments
 (0)