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: update code block in ADR-006 #874

Merged
merged 2 commits into from
Oct 17, 2022

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Oct 16, 2022

Addresses informalsystems/audit-celestia#20 (comment)

Question for reviewers: do we treat ADRs as a snapshot in time or should we update them to reflect changes that take place after the ADR was reviewed?

@rootulp rootulp added the documentation Improvements or additions to documentation label Oct 16, 2022
@rootulp rootulp self-assigned this Oct 16, 2022
Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

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

Question for reviewers: do we treat ADRs as a snapshot in time or should we update them to reflect changes that take place after the ADR was reviewed?

we can do both, as that's what tendermint and cosmos do. Updating can be tedious, and we should only do it if it makes sense (or is requested) or leave them as good beginner issues imo

docs/architecture/adr-006-non-interactive-defaults.md Outdated Show resolved Hide resolved
@@ -1,3 +1,5 @@
"default": true # Default state for all rules
"MD010":
"code_blocks": false # Disable rule for hard tabs in code blocks
Copy link
Member

Choose a reason for hiding this comment

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

🔥 🔥 👍

@rootulp rootulp merged commit 6d385c5 into celestiaorg:main Oct 17, 2022
rach-id pushed a commit to rach-id/celestia-app that referenced this pull request Nov 16, 2022
Addresses
informalsystems/audit-celestia#20 (comment)

Question for reviewers: do we treat ADRs as a snapshot in time or should
we update them to reflect changes that take place after the ADR was
reviewed?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants