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

Update the README file to reflect a more "modern" approach to README/Github SEO #37

Open
JohnVonNeumann opened this issue Oct 31, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@JohnVonNeumann
Copy link
Member

JohnVonNeumann commented Oct 31, 2024

The README's for ZTF projects have been a fairly consistent second thought, which needs to change. I have some rough drafts ready which need to be finalised.

Update:

What I'm looking for reflects something from the incredible repo from cal.com, whose README is here:

https://github.com/calcom/cal.com/blob/main/README.md

And this should also serve as some good insights which influenced the thought behind this ticket.

https://www.codemotion.com/magazine/dev-life/github-project/

@JohnVonNeumann JohnVonNeumann added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 31, 2024
@JohnVonNeumann JohnVonNeumann self-assigned this Oct 31, 2024
@tntruong-iter
Copy link

Hi @JohnVonNeumann, could you please assign this issue to me? I'd like to work on it. Thanks!"

@JohnVonNeumann
Copy link
Member Author

Hey @tntruong-iter thank you for reaching out, in terms of assigning the issue, I have had a few people express interest in this ticket, and so I have removed myself from the ticket itself but I will be leaving it open to whoever wishes to contribute. If you'd like to submit a patch I'd welcome it immensely. I also have a similar ticket on our other project here; ZeroTwentyFifty/pact_methodology#35

I hope to see a PR soon, thank you for your interest!

@JohnVonNeumann JohnVonNeumann removed their assignment Nov 5, 2024
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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants