Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

Commit

Permalink
Update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
elizabethengelman committed May 8, 2019
1 parent 3a9860d commit 3caae7c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,9 @@ Documentation on how to build custom transformers to work with these commands ca


## Contributing
Contributions are welcome! For more on this, please see [here](../staging/documentation/contributing.md).

Small note: If editing the Readme, please conform to the [standard-readme specification](https://github.com/RichardLitt/standard-readme).
Contributions are welcome!

For more on this, please see [here](../staging/documentation/contributing.md).

## License
[AGPL-3.0](../staging/LICENSE) © Vulcanize Inc
16 changes: 14 additions & 2 deletions documentation/contributing.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# 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 Requests
- `go fmt` is run as part of `make test` and `make integrationtest`, please make sure to check in the format changes.
- Ensure that new code is well tested, including integration testing if applicable.
- Make sure the build is passing.
- 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.

0 comments on commit 3caae7c

Please sign in to comment.