-
Notifications
You must be signed in to change notification settings - Fork 214
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into fix-unfreeze-after-new-stake
- Loading branch information
Showing
1 changed file
with
50 additions
and
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,15 +24,15 @@ Lava is built using the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) whic | |
**Note**: Requires [Go 1.20.5](https://golang.org/dl/) | ||
|
||
## Quick Start | ||
|
||
The best way to start working with lava is to use docker, for additional reading go to: | ||
[Running via compose](docker/README.md) | ||
|
||
## Contributing | ||
|
||
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute. If you want to follow the updates or learn more about the latest design then join our [Discord](https://discord.com/invite/Tbk5NxTCdA). | ||
|
||
## Developing | ||
## Developing | ||
|
||
### Installing development dependencies | ||
|
||
|
@@ -73,6 +73,54 @@ Or check out the latest [release](https://github.com/lavanet/lava/releases). | |
|
||
You can add a useful autocomplete feature to `lavad` & `lavap` with a simple bash [script](https://github.com/lavanet/lava/blob/main/scripts/automation_scripts/lava_auto_completion_install.sh). | ||
|
||
### Syncing Specs with `lavanet/lava-config` repository | ||
|
||
The specs in this directory need to be synchronized with the [lavanet/lava-config](https://github.com/lavanet/lava-config) repository. This ensures that the specifications are consistent across the Lava Network ecosystem. | ||
|
||
#### Initial Setup (Historical Reference) | ||
|
||
The specs directory was initially set up as a git subtree using these commands: | ||
|
||
```bash | ||
# Add a remote to track the lava-config repository | ||
git remote add lava-config [email protected]:lavanet/lava-config.git # This creates a named reference to the remote repository | ||
|
||
# Add the subtree by pulling from the remote | ||
git subtree add --prefix specs lava-config main --squash | ||
``` | ||
|
||
#### Pulling Updates from lava-config | ||
|
||
To get the latest changes from the lava-config repository: | ||
|
||
```bash | ||
git subtree pull --prefix specs lava-config main --squash | ||
``` | ||
|
||
#### Contributing Changes | ||
|
||
To contribute changes to lava-config: | ||
|
||
1. First, fork the [lavanet/lava-config](https://github.com/lavanet/lava-config) repository to your GitHub account. | ||
|
||
2. After making your changes to the specs, you can: | ||
|
||
```bash | ||
# Create a branch containing only the specs directory history | ||
git subtree split --prefix=specs -b <branch-name> --squash | ||
|
||
# Push your changes to your fork | ||
git push <your-fork-remote> <branch-name> | ||
``` | ||
|
||
3. Create a Pull Request from your fork to the main lavanet/lava-config repository. | ||
|
||
The `git remote add` command creates a named reference ("lava-config") to the remote repository, making it easier to push and pull changes. Without it, you'd need to specify the full repository URL each time. | ||
|
||
The `git subtree split` command is useful when you want to extract the history of just the specs directory into its own branch. This can be helpful when preparing changes for a pull request, as it gives you a clean history of only the specs-related changes. | ||
|
||
Remember to always test your changes locally before submitting a PR to ensure the specifications are valid and properly formatted. | ||
|
||
## Join Lava | ||
|
||
Join Lava's testnet, [read instructions here](https://docs.lavanet.xyz/testnet?utm_source=github.com&utm_medium=github&utm_campaign=readme) | ||
|