Skip to content

README.md initial draft #10

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

jorge-campo
Copy link
Contributor

@cheny0 , let me know if there's any section I'm missing or if you have suggestions to improve the README.

Some notes:

  • We will include a simple contributor's guide in the README and link to the Style Guide for detailed instructions.
  • I created a table that lists the different project phases and their corresponding statuses (traffic lights).
  • Each week, we'll feel out what's new for the week, with links to the corresponding discussion or issues.
  • Some parts of the README are commented. We'll make them visible when things are ready.
  • I will ask Francesca for a nice illustration to use as a header.

@jorge-campo jorge-campo requested a review from cheny0 July 2, 2025 14:55
@jorge-campo jorge-campo self-assigned this Jul 2, 2025
@jorge-campo jorge-campo added the deliverables Any other project deliverable label Jul 2, 2025
@jorge-campo jorge-campo linked an issue Jul 2, 2025 that may be closed by this pull request
@cheny0
Copy link

cheny0 commented Jul 3, 2025

It looks good to me. I just have one concern: what if the weekly update becomes a lengthy list? It can be stressful to see a big README. How about moving the update to another file?

@jorge-campo
Copy link
Contributor Author

It looks good to me. I just have one concern: what if the weekly update becomes a lengthy list? It can be stressful to see a big README. How about moving the update to another file?

That's the idea: to keep only the last one to two weeks in the README file and move the old records to another file. This was the intention with these lines: https://github.com/status-im/ift-docs/pull/10/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R81-R83

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deliverables Any other project deliverable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update project's README.md
2 participants