mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2026-02-09 22:50:54 +00:00
update default docs and release process, drop bumpversion for
bump-my-version
This commit is contained in:
57
README.md
57
README.md
@ -8,61 +8,12 @@
|
||||
|
||||
<SHORT_DESCRIPTION>
|
||||
|
||||
Read more in the [documentation on ReadTheDocs](https://<RTD_NAME>.readthedocs.io/). [View the change log](https://<RTD_NAME>.readthedocs.io/en/latest/release_notes.html).
|
||||
Read the [documentation](https://<RTD_NAME>.readthedocs.io/).
|
||||
|
||||
## Quickstart
|
||||
View the [change log](https://<RTD_NAME>.readthedocs.io/en/latest/release_notes.html).
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
python -m pip install <PYPI_NAME>
|
||||
```
|
||||
|
||||
## Developer Setup
|
||||
|
||||
If you would like to hack on <REPO_NAME>, 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/<REPO_NAME>.git
|
||||
cd <REPO_NAME>
|
||||
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"`
|
||||
|
||||
Reference in New Issue
Block a user