Clean up Communication Section of the Readme
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
Research direction
Start in the README's Communication section, especially the list describing communication types between BAP, BG, and BPP. Clarify or link the acronyms and consolidate the repeated statements about asynchronous communication; done means the section is understandable without prior protocol knowledge and no longer repeats itself.
Written by the indexing model from the issue text.
Description
The communication header of the readme could be cleaned up a little. I'm new to the protocol, so I was reading through to get a better idea of it.
At this point in the readme, there's a list of "types of communication" between a "BAP, BG, BPP" etc. These aren't familiar to me, and a quick search only brings me back here. Rather than using acronyms, these should be described, or maybe left to more specific documentation and linked to here.
Also, the last paragraph is essentially a repeat of the first. Both say the protocol is asynchronous, so this should be consolidated.
Overall very interesting project, I'm intrigued! I hope this feedback is well received.
- Dominant language
- No language data
- Stars
- 455
- Forks
- 127
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from beckn/protocol-specifications
-
Migrate default branch from `master` to `main`May be free again @ravi-prakash-v claimed this 402 days ago, and no pull request is open. Openworking group meeting
beckn/protocol-specifications#491 · 1 assignee ·
-
Proofread and improve documentationMay be free again @NIGHTFURY609 claimed this 541 days ago, and no pull request is open. Open
Difficulty 3/5 1-2 days Newbie friendliness 48/100
beckn/protocol-specifications#472 · 3 comments ·
-
Restructure spec repos to allow more interactive learning of the specMay be free again @rajaneeshk90 claimed this 746 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#455 · 1 assignee ·
-
Design specifications for Open Data platformMay be free again @rajaneeshk90 claimed this 746 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#454 · 1 assignee ·
-
Protocol-Specification Version 1.2 releaseMay be free again @rajaneeshk90 claimed this 746 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#451 · 2 comments · 1 assignee ·
All issues in beckn/protocol-specifications
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
good first issue help wanted Project:Docs workshop
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
auto-rejected intake mcp-intake needs-salvage priority:high type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Ikalus1988/MisakaNet#4221 · 2 comments ·
Maintainers usually reply within 1 day