diff --git a/README.md b/README.md index 89e4e2c..7e41ff2 100644 --- a/README.md +++ b/README.md @@ -17,59 +17,6 @@ Read more in the documentation below. [View the change log](https://github.com/e python -m pip install eth-keys ``` -## Developer Setup - -If you would like to hack on eth-keys, please check out the [Snake Charmers -Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual) -for information on how we do: - -- Testing -- Pull Requests -- Documentation - -We use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once -installed, it will run automatically with every commit. You can also run it manually -with `make lint`. If you need to make a commit that skips the `pre-commit` checks, you -can do so with `git commit --no-verify`. - -### Development Environment Setup - -You can set up your dev environment with: - -```sh -git clone git@github.com:ethereum/eth-keys.git -cd eth-keys -virtualenv -p python3 venv -. venv/bin/activate -python -m pip install -e ".[dev]" -pre-commit install -``` - -### Release setup - -To release a new version: - -```sh -make release bump=$$VERSION_PART_TO_BUMP$$ -``` - -#### How to bumpversion - -The version format for this repo is `{major}.{minor}.{patch}` for stable, and -`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta). - -To issue the next version in line, specify which part to bump, -like `make release bump=minor` or `make release bump=devnum`. This is typically done from the -main branch, except when releasing a beta (in which case the beta is released from main, -and the previous stable branch is released from said branch). - -If you are in a beta version, `make release bump=stage` will switch to a stable. - -To issue an unstable version when the current version is stable, specify the -new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"` - -## QuickStart - ```python >>> from eth_keys import keys >>> pk = keys.PrivateKey(b'\x01' * 32) @@ -326,3 +273,54 @@ invalid. This error is raised from any of the `recover` or `verify` methods involving signatures if the signature is invalid. + +## Developer Setup + +If you would like to hack on eth-keys, please check out the [Snake Charmers +Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual) +for information on how we do: + +- Testing +- Pull Requests +- Documentation + +We use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once +installed, it will run automatically with every commit. You can also run it manually +with `make lint`. If you need to make a commit that skips the `pre-commit` checks, you +can do so with `git commit --no-verify`. + +### Development Environment Setup + +You can set up your dev environment with: + +```sh +git clone git@github.com:ethereum/eth-keys.git +cd eth-keys +virtualenv -p python3 venv +. venv/bin/activate +python -m pip install -e ".[dev]" +pre-commit install +``` + +### Release setup + +To release a new version: + +```sh +make release bump=$$VERSION_PART_TO_BUMP$$ +``` + +#### How to bumpversion + +The version format for this repo is `{major}.{minor}.{patch}` for stable, and +`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta). + +To issue the next version in line, specify which part to bump, +like `make release bump=minor` or `make release bump=devnum`. This is typically done from the +main branch, except when releasing a beta (in which case the beta is released from main, +and the previous stable branch is released from said branch). + +If you are in a beta version, `make release bump=stage` will switch to a stable. + +To issue an unstable version when the current version is stable, specify the +new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"`