Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add default params to the spec #2416

Merged
merged 12 commits into from
Sep 4, 2023
Merged

Conversation

evan-forbes
Copy link
Member

Overview

note that the descriptions have been updated from what was in notion to be consistent and correct a few minor nuances

closes #2413

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@evan-forbes evan-forbes added specs directly relevant to the specs gov param item is directly related to a governance modifiable parameter. labels Sep 4, 2023
@evan-forbes evan-forbes self-assigned this Sep 4, 2023
@celestia-bot celestia-bot requested a review from a team September 4, 2023 13:32
@evan-forbes evan-forbes added the backport:v1.x PR will be backported automatically to the v1.x branch upon merging label Sep 4, 2023
@github-actions
Copy link

github-actions bot commented Sep 4, 2023

PR Preview Action v1.4.4
🚀 Deployed preview to https://celestiaorg.github.io/celestia-app/pr-preview/pr-2416/
on branch gh-pages at 2023-09-04 21:37 UTC

specs/src/specs/params.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Sep 4, 2023

Codecov Report

Merging #2416 (298925f) into main (d17e231) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2416   +/-   ##
=======================================
  Coverage   20.61%   20.61%           
=======================================
  Files         131      131           
  Lines       15270    15270           
=======================================
  Hits         3148     3148           
  Misses      11820    11820           
  Partials      302      302           

specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
@celestia-bot celestia-bot requested a review from a team September 4, 2023 18:34
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
Copy link
Member

@liamsi liamsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a few changes for consistency are necessary. Also, I'm not sure the param for the qgb is missing or not. Other than that looks good. Thanks for the quick turnaround!

specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
specs/src/specs/params.md Outdated Show resolved Hide resolved
Copy link
Member

@liamsi liamsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏼

@evan-forbes evan-forbes merged commit 4e62d2d into main Sep 4, 2023
28 checks passed
@evan-forbes evan-forbes deleted the evan/add-params-to-the-specs branch September 4, 2023 22:23
mergify bot pushed a commit that referenced this pull request Sep 4, 2023
## Overview

note that the descriptions have been updated from what was in notion to
be consistent and correct a few minor nuances

closes #2413

## Checklist

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords

---------

Co-authored-by: John Adler <[email protected]>
(cherry picked from commit 4e62d2d)

# Conflicts:
#	specs/src/README.md
#	specs/src/SUMMARY.md
evan-forbes added a commit that referenced this pull request Sep 5, 2023
This is an automatic backport of pull request #2416 done by
[Mergify](https://mergify.com).
Cherry-pick of 4e62d2d has failed:
```
On branch mergify/bp/v1.x/pr-2416
Your branch is up to date with 'origin/v1.x'.

You are currently cherry-picking commit 4e62d2d.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   specs/src/specs/params.md

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   specs/src/README.md
	both modified:   specs/src/SUMMARY.md

```


To fix up this pull request, you can check it out locally. See
documentation:
https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

---


<details>
<summary>Mergify commands and options</summary>

<br />

More conditions and actions can be found in the
[documentation](https://docs.mergify.com/).

You can also trigger Mergify actions by commenting on this pull request:

- `@Mergifyio refresh` will re-evaluate the rules
- `@Mergifyio rebase` will rebase this PR on its base branch
- `@Mergifyio update` will merge the base branch into this PR
- `@Mergifyio backport <destination>` will backport this PR on
`<destination>` branch

Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you
can:

- look at your merge queues
- generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com
</details>

---------

Co-authored-by: Evan Forbes <[email protected]>
Co-authored-by: evan-forbes <[email protected]>
evan-forbes added a commit that referenced this pull request Sep 14, 2023
## Overview

minor update to the defaults to match #2416. ofc, these are not
consensus breaking as they're just changes to the defaults. This saves
us from having to manually change this for mainnet or mocha


## Checklist

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords

---------

Co-authored-by: Rootul P <[email protected]>
mergify bot pushed a commit that referenced this pull request Sep 14, 2023
## Overview

minor update to the defaults to match #2416. ofc, these are not
consensus breaking as they're just changes to the defaults. This saves
us from having to manually change this for mainnet or mocha

## Checklist

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords

---------

Co-authored-by: Rootul P <[email protected]>
(cherry picked from commit 9fa9fbf)

# Conflicts:
#	app/default_overrides.go
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:v1.x PR will be backported automatically to the v1.x branch upon merging gov param item is directly related to a governance modifiable parameter. specs directly relevant to the specs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a list of the mainnet parameters to the spec
5 participants