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.

Sign up for GitHub

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

Jump to bottom

Readme Overhaul #39

Merged
merged 13 commits into from
Jan 9, 2022
Merged

Readme Overhaul #39

merged 13 commits into from
Jan 9, 2022

Conversation

not-nef
Copy link
Member

@not-nef not-nef commented Jan 6, 2022

What do you think? Suggestions are welcomed and wanted!

@not-nef not-nef added the documentation Improvements or additions to documentation label Jan 6, 2022
@not-nef not-nef marked this pull request as draft January 6, 2022 21:34
@Futura-Py Futura-Py locked and limited conversation to collaborators Jan 6, 2022
@Futura-Py Futura-Py unlocked this conversation Jan 6, 2022
@im-coder-lg
Copy link
Member

Excellent!

@im-coder-lg im-coder-lg marked this pull request as ready for review January 7, 2022 02:44
@im-coder-lg
Copy link
Member

I say this is ready for review!

@im-coder-lg
Copy link
Member

Also, before the word release in the SVG, can you try adding Latest? It might make users clear that we are giving the latest release.

@sumeshir26
Copy link
Member

@not-nef @im-coder-lg I still think there should be a banner to inform users about new releases.

@im-coder-lg
Copy link
Member

im-coder-lg commented Jan 7, 2022 •
edited
Loading

Yeah even me... Why not the banner be on the website? I mean, that's where users would head for documentation, a gist of features, and etc.
Maybe... We'll enlarge the SVG sizing and maybe modify the text(not the size) a bit.

im-coder-lg
im-coder-lg previously requested changes Jan 7, 2022
View reviewed changes
Copy link
Member

@im-coder-lg im-coder-lg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SVG sizing and maybe text modification. What's your idea?

@sumeshir26
Copy link
Member

@not-nef Maybe we can add more badges through this: https://github.com/Ileriayo/markdown-badges

@im-coder-lg
Copy link
Member

im-coder-lg commented Jan 7, 2022 •
edited by sumeshir26
Loading

Maybe these badges:

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
![Gitpod](https://img.shields.io/badge/gitpod-f06611.svg?style=for-the-badge&logo=gitpod&logoColor=white)
![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)
![GitHub Actions](https://img.shields.io/badge/githubactions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
![Repl.it](https://img.shields.io/badge/Repl.it-%230D101E.svg?style=for-the-badge&logo=replit&logoColor=white)

These are the ones that seem related for us; any ideas?

@im-coder-lg
Copy link
Member

We could make the SVGs into links, so I could try linking them like a suggestion.

@sumeshir26
Copy link
Member

This one as well:
![Repl.it](https://img.shields.io/badge/Repl.it-%230D101E.svg?style=for-the-badge&logo=replit&logoColor=white)

@im-coder-lg
Copy link
Member

I thought of it, well let's add them!

@not-nef
Copy link
Member Author

not-nef commented Jan 7, 2022

ok

@not-nef
Copy link
Member Author

not-nef commented Jan 7, 2022

it looks terrible @im-coder-lg. i wouldnt use those and just leave the release bade there. But you guys say what to do.

@not-nef
Copy link
Member Author

not-nef commented Jan 7, 2022

image

i mean cmon it just looks trash with that small release badge. But i say we definitely need to keep the release badge and tbh i dont think the others are that important.

@sumeshir26
Copy link
Member

@not-nef Let me try to make a custom release badge

@im-coder-lg
Copy link
Member

Wait are you designing a SVG?

@im-coder-lg
Copy link
Member

image

@not-nef that's what we need.

i mean cmon it just looks trash with that small release badge. But i say we definitely need to keep the release badge and tbh i dont think the others are that important.

Hold up! You are using HTML! Just use a width attribute inside your <img> tag!

@sumeshir26
Copy link
Member

@im-coder-lg Yours is a much better idea

@im-coder-lg
Copy link
Member

@not-nef seems to be confused. I think 50px is a better idea. I will give the code here, all you need to do is replace and commit.
Don't get confused, it's so easy. Just copy the line, replace it on Line 8 and commit.
Line 8:

        <img src="https://img.shields.io/github/release/sumeshir26/TimerX.svg?style=flat-square" alt="Releases" />

To:

        <img src="https://img.shields.io/github/release/sumeshir26/TimerX.svg?style=flat-square" alt="Releases" width="50px" />

@netlify
Copy link

netlify bot commented Jan 8, 2022 •
edited
Loading

✔️ Deploy Preview for timerx-app canceled.

🔨 Explore the source changes: 3ad1eb1

🔍 Inspect the deploy log: https://app.netlify.com/sites/timerx-app/deploys/61d98efdd3324300074f7c41

@not-nef
Copy link
Member Author

not-nef commented Jan 8, 2022

@im-coder-lg @sumeshir26 what do you guys think of the new Contributing file?

@not-nef not-nef requested a review from im-coder-lg January 8, 2022 09:52
@im-coder-lg
Copy link
Member

Never noticed it... I will inspect it to fix grammatical issues. Also #41 needs urgent merging!

@im-coder-lg
Copy link
Member

I will manage the Contributing guide. Do I need write access to edit since it's on your fork?

@im-coder-lg
Copy link
Member

The contributing guide is kinda messed up. It's haywire, like my method. But don't you worry. I will fix things up. I was waiting to make this, you did! I will make the same file over at the website too!

@not-nef
Copy link
Member Author

not-nef commented Jan 8, 2022

cool

@im-coder-lg
Copy link
Member

Updated the contributing guide. Made sure the base was yours, I added some extras. Maybe I'll make it easy for new people to contribute here.

@im-coder-lg
fix: Remove the . from contrib guide link
3d629bd 
A URL redirects, so a `.` might make it hard. Great work @not-nef though, you made the refactor and styling.
@im-coder-lg
Copy link
Member

Now, I can approve.

im-coder-lg
im-coder-lg approved these changes Jan 8, 2022
View reviewed changes
Copy link
Member

@im-coder-lg im-coder-lg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lasgtm(looks and seems good to me)

README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@im-coder-lg
Copy link
Member

@sumeshir26 your opinions needed! PS: Some new PRs opened, please inspect)

@not-nef
Copy link
Member Author

not-nef commented Jan 8, 2022

@im-coder-lg i think we should get rid of the todo list since i dont think it belongs in the readme. if we keep it i think we should put it in another document.

@sumeshir26 sumeshir26 added the approved This pull request is ready to merge label Jan 9, 2022
@sumeshir26
Copy link
Member

Should I merge?

im-coder-lg
im-coder-lg approved these changes Jan 9, 2022
View reviewed changes
Copy link
Member

@im-coder-lg im-coder-lg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@sumeshir26 sumeshir26 merged commit ca72e4f into Futura-Py:master Jan 9, 2022
@not-nef not-nef deleted the Readme-Overhaul branch January 9, 2022 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@im-coder-lg im-coder-lg im-coder-lg approved these changes

@sumeshir26 sumeshir26 sumeshir26 approved these changes

Assignees
No one assigned
Labels
approved This pull request is ready to merge documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@not-nef @im-coder-lg @sumeshir26