This repository has been archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a9860d
commit 5275a0d
Showing
2 changed files
with
15 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,22 @@ | ||
# Contribution guidelines | ||
|
||
Contributions are welcome! In addition to core contributions, developers are encouraged to build their own custom transformers which | ||
Contributions are welcome! Please open an Issues or Pull Request for any changes. | ||
|
||
In addition to core contributions, developers are encouraged to build their own custom transformers which | ||
can be run together with other custom transformers using the [composeAndExeucte](../../staging/documentation/composeAndExecute.md) command. | ||
|
||
## Pull Request Process | ||
- `go fmt` is run as part of `make test` and `make integrationtest`, please make sure to check in the format changes. | ||
- Make sure the build is passing (this includes ) | ||
- Update the README or any [documentation files](./) as necessary. If editing the Readme, please | ||
conform to the | ||
[standard-readme specification](https://github.com/RichardLitt/standard-readme). | ||
- You may merge a Pull Request once you have an approval from core developer. | ||
|
||
## Creating a new migration file | ||
1. `make new_migration NAME=add_columnA_to_table1` | ||
- This will create a new timestamped migration file in `db/migrations` | ||
1. Write the migration code in the created file, under the respective `goose` pragma | ||
- Goose automatically runs each migration in a transaction; don't add `BEGIN` and `COMMIT` statements. | ||
1. Core migrations should be committed in their `goose fix`ed form. | ||
1. Core migrations should be committed in their `goose fix`ed form. To do this, run `make version_migrations` which | ||
converts timestamped migrations to migrations versioned by an incremented integer. |