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

README.md revamp #1747

Closed
7 of 11 tasks
crodriguezvega opened this issue Jul 20, 2022 · 4 comments · Fixed by #5171
Closed
7 of 11 tasks

README.md revamp #1747

crodriguezvega opened this issue Jul 20, 2022 · 4 comments · Fixed by #5171
Assignees
Labels
docs Improvements or additions to documentation

Comments

@crodriguezvega
Copy link
Contributor

crodriguezvega commented Jul 20, 2022

Possible content for an improved README.md. Each of this items is a section title with a brief explanation of the content under it.

  • Introduction
    • Project description (I guess we can use the text that we already have, but maybe we could add as well a link to Adi's ELI5 blog post - as we have done in the spec repo)
  • Vision
    • Explain the long-term goals and focus of the repo.
  • Roadmap
  • Releases
    • Include link to version matrix.
  • Ecosystem
    • The apps/middlewares/light-clients registry.
  • Contributing
    • Summary of contributing guidelines and link to full text.
    • Maybe a collage of small pictures of all the contributors to the project? (for example like this)
  • Support
    • How to reach us and explain what each medium is most suited for (Discord, Telegram, GitHub discussions, etc).
  • License
  • Security
    • Link to bug bounty program and explain how to submit an issue.
  • Resources
    • List of links to the spec, docs, relevant wiki pages, other relevant project (hermes, rly), etc.
  • A paragraph at the end explaining that the team at Interchain GmbH is the primary maintainer and that funding comes from the ICF

Please comment with any other content that we should add.

@crodriguezvega crodriguezvega added docs Improvements or additions to documentation needs discussion Issues that need discussion before they can be worked on labels Jul 20, 2022
@crodriguezvega crodriguezvega added this to the Q3-2022-backlog milestone Jul 20, 2022
@charleenfei
Copy link
Contributor

i think there should be a more direct link between the high level categories on the roadmap and the project boards in the repo, maybe an additional project board which is just an "epic tracker" that serves as that link, or direct links on the roadmap.

@crodriguezvega
Copy link
Contributor Author

crodriguezvega commented Jul 21, 2022

i think there should be a more direct link between the high level categories on the roadmap and the project boards in the repo, maybe an additional project board which is just an "epic tracker" that serves as that link, or direct links on the roadmap.

The roadmap file contains already a bunch of links to epic issues, milestones or boards (if available at the moment of writing the roadmap). Would this be enough or you have something else in mind?

The epic tracker board is something that we can also add.

@charleenfei
Copy link
Contributor

I guess I mean a one stop shop view from the project board to the roadmap (ie: epic tracker board). The roadmap file contains links but they are in the middle of text, i guess i meant something more like you can track the progress of whats happening on the roadmap.

@colin-axner
Copy link
Contributor

yay! Super excited for this :)

@crodriguezvega crodriguezvega moved this to Todo in ibc-go Aug 4, 2022
@crodriguezvega crodriguezvega self-assigned this Aug 4, 2022
@crodriguezvega crodriguezvega moved this from Todo to In progress in ibc-go Aug 18, 2022
@crodriguezvega crodriguezvega removed the needs discussion Issues that need discussion before they can be worked on label Aug 23, 2022
@crodriguezvega crodriguezvega removed this from the Q3-2022-backlog milestone Oct 17, 2022
@crodriguezvega crodriguezvega moved this to In progress in ibc-go Nov 1, 2022
@charleenfei charleenfei moved this from In progress to Todo in ibc-go Nov 23, 2022
@colin-axner colin-axner moved this from Todo to In progress in ibc-go Nov 24, 2022
@crodriguezvega crodriguezvega moved this from In progress to In review in ibc-go Nov 26, 2023
@github-project-automation github-project-automation bot moved this from In review to Done in ibc-go Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants