From 5d1ba5903cb72374ab815c7c3668e9e92d1851e6 Mon Sep 17 00:00:00 2001 From: Elizabeth Engelman Date: Wed, 8 May 2019 13:19:32 -0500 Subject: [PATCH] Update contributing guidelines --- README.md | 7 +++---- documentation/contributing.md | 16 ++++++++++++++-- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 02d83da4..94075541 100644 --- a/README.md +++ b/README.md @@ -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 +[AGPL-3.0](../staging/LICENSE) © Vulcanize Inc \ No newline at end of file diff --git a/documentation/contributing.md b/documentation/contributing.md index db255507..2dfa2102 100644 --- a/documentation/contributing.md +++ b/documentation/contributing.md @@ -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. \ No newline at end of file +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.