Commit Graph

14 Commits

Author SHA1 Message Date
Julien Robert 58597139fa
docs: Improve markdownlint configuration (#11104)
## Description

Closes: #9404



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
2022-02-10 12:07:01 +00:00
Ryan Christoffersen cb66c99eab
chore: add markdownlint to lint commands (#9353)
* add markdownlint config

* update make lint commands

* update markdownlint config

* run make lint-fix

* fix empty link

* resuse docker container

* run lint-fix

* do not echo commands

Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
2021-05-27 15:31:04 +00:00
Robert Zaremba 1ec6c640b9
ADR template: add Further Discussions (#8108)
* ADR template: add Further Discussions

* language update

* Update docs/architecture/adr-template.md

Co-authored-by: Amaury <amaury.martiny@protonmail.com>

Co-authored-by: Amaury <amaury.martiny@protonmail.com>
2020-12-09 10:36:48 +00:00
Robert Zaremba 5bebf2bd39
ADR: add a process proposal (#7621)
* ADR: add a process proposal

* wording update

* Update docs/architecture/PROCESS.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/PROCESS.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/PROCESS.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Add more details to status section and update the template

* Update docs/architecture/PROCESS.md

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

* add a note about ADR pruning

* use sequence numbers

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-10-22 22:40:44 +00:00
Robert Zaremba 435fc83ba7
Updating the ADR template (#7449)
* Updating the ADR template

Introducing few small sections to the template:

* Summary: IMHO it's very valuable for every reader to quickly see what this ADR is about. Must be short.
* Backwards Compatibility -- each ADR MUST analyze backward compatibility issue. Let's make it clear and put as the ADR subsection.
* Test Cases -- often, when analyzing a problem and implementing a solution, it's very useful to define test-cases. Hence it SHOULD be a part of the template.

Inspiration: Enterprise Ethreum Alliance Proposal [template](https://github.com/EntEthAlliance/EEPs/blob/master/draft/templates/EEP0002-Standards_Proposal_Template.md)

* change Summary -> Abstract
2020-10-05 21:34:41 +00:00
Federico Kunze 3022fe9044
x/ibc-transfer: ADR001 source tracing implementation (#6871)
* x/ibc-transfer: ADR001 source tracing implementation

* gRPC proto file

* validation

* fix validation

* import export genesis

* relay.go updates

* gRPC service methods

* client CLI

* update implementation

* build

* trace test

* fix CLI tx args

* genesis import/export tests

* update comments

* update proto files

* GRPC tests

* remove field from packet

* fix coin validation bug

* more validations

* update comments

* minor refactor

* update relay.go

* try fix test

* minor updates

* fix tests

* fix test

* ADR updates and comments

* build

* Apply suggestions from code review

Co-authored-by: Aditya <adityasripal@gmail.com>
Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* address a few comments from review

* gRPC annotations

* update proto files

* Apply suggestions from code review

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* address comments

* docs and changelog

* sort traces

* final changes to ADR

* client support for full path denom prefixes

* address @AdityaSripal comments

* address TODO

* increase test timeouts

Co-authored-by: Aditya <adityasripal@gmail.com>
Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
2020-08-14 17:46:26 -04:00
Alexander Bezobchuk 8bc645a418
ADR 024 - Coin Metadata (#6253)
* Start draft

* Add context

* Updates

* Fix tabbing

* Fix title

* Update docs/architecture/adr-024-coin-metadata.md

Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com>

* revise aliases

* Add section on total supply and gen state

* Add section on aliases

* Add section on gov

* Update docs/architecture/adr-024-coin-metadata.md

Co-authored-by: Aaron Craelius <aaron@regen.network>

* Add ext

* Remove extensions

* Add special treatment for base and display denomination (#6351)

Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com>
Co-authored-by: Aaron Craelius <aaron@regen.network>
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>
2020-06-07 01:05:22 +00:00
Alexander Bezobchuk 5ee65cb897
Merge PR #5650: ADR 019 - Protocol Buffer State Encoding 2020-02-17 17:10:54 +01:00
Christopher Goes 202cb9be0b Merge PR #5340: ADR 17: Historical header module 2019-12-04 10:18:02 -05:00
mircea-c 450c8ced2c Merge PR #4787: Updated docs build process 2019-08-26 09:09:18 -04:00
Marko b45a94a54e Merge PR #4743: Update ADR template 2019-07-19 15:53:36 +02:00
Marko 7bc705af85 ADR section to Contribution (#4703)
- Added a ADR section to the Contributing.md
- This will streamline and create a central palce for discussions
- Currently conversations are fragmented across platfroms and different forum posts,
  the aim here is to move it all to one place and create a document to be used as
  reference in the future for why SDK went in this direction.
2019-07-18 15:17:40 +01:00
Dev Ojha b09e8599d9 Merge PR #2334: ADR for global message counter 2018-09-17 23:26:21 +08:00
Dev Ojha b5f8350dff Merge PR #2333: Copy ADR template from Tendermint
* Copy ADR template from Tendermint

* Modify @alexanderbez 's ADR template
2018-09-13 22:01:30 -04:00