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

Revamp the README.md with a lick of paint 🎨 #179

Merged
merged 19 commits into from
Aug 3, 2023
Merged

Revamp the README.md with a lick of paint 🎨 #179

merged 19 commits into from
Aug 3, 2023

Conversation

JamieSlome
Copy link
Member

Closes #177

@JamieSlome JamieSlome added the documentation Improvements or additions to documentation label Jun 30, 2023
@JamieSlome JamieSlome self-assigned this Jun 30, 2023
@JamieSlome JamieSlome linked an issue Jun 30, 2023 that may be closed by this pull request
Revamp the README.md with a lick of paint 🎨 #177
Closed
@JamieSlome
style: correct coloring on badge and remove <kbd> usage
c84602e
@JamieSlome
style: remove title and spacing in README.md
c9b68d2
@JamieSlome
chore: correct shields.io references for repository in badges
98bdc2f
@JamieSlome
chore: remove office hours reference in README.md header
324c84c
@JamieSlome
style: add git proxy demo shot and core headers for each section
bc04316
@JamieSlome
chore: align git proxy demo image to the right of README.md
f0187ca
@JamieSlome
chore: make demo image simpler & remove badge spacing
60ac1a3
@JamieSlome
chore: add line break in between badges for better readability
0347957
@JamieSlome
chore: populate about, installation and contribution sections
969b2fc
@JamieSlome
style: remove redundant padding from image and replace with line brea…
d2e39a0 
…ks and manual padding
@JamieSlome
chore: remove usage of line breaks and spacing around git proxy demo …
58f3e95 
…image
@JamieSlome
docs: add security.md reference in the README.md
fc68fcd
@JamieSlome
chore: improve contribution guidelines for branch, commit, code and push
bb7d610
@JamieSlome
chore: add spacing to improve readability of contribution section of …
ddbb75a 
…README.md
@JamieSlome
chore: correct grammar and spelling in README.md
616d15e
@JamieSlome
Copy link
Member Author

@maoo - more of an approach preference, but should we remove the usage section of this for now, merge the PR, and reconcile the invocation of the library, as it still needs work? We can then look to update the usage section after?

@maoo
Copy link
Member

maoo commented Aug 2, 2023

Sounds good, especially considering that for the Usage part we may need a dedicated MD file; let's iterate on this later. TY!

@JamieSlome JamieSlome marked this pull request as ready for review August 2, 2023 10:03
@JamieSlome
Copy link
Member Author

@maoo - ready for your review 👍 You might need to disable the Linting merge requirement for the time being.

@JamieSlome
Copy link
Member Author

Bump @maoo 👊

maoo
maoo reviewed Aug 3, 2023
View reviewed changes
Copy link
Member

@maoo maoo left a comment

Choose a reason for hiding this comment

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

Looks really nice, great work @JamieSlome !

The only thing that I would change is Otherwise, reach out to [opensource@citi.com](mailto:opensource@citi.com). at the bottom of the README. I'd suggest to keep communication public and hosted on GitHub, as much as possible.

If you need an email address that can relay messages, you can mention help@finos.org .

WDYT?

@JamieSlome
Copy link
Member Author

@maoo - done ✅

maoo
maoo approved these changes Aug 3, 2023
View reviewed changes
Copy link
Member

@maoo maoo left a comment

Choose a reason for hiding this comment

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

LGTM!

@JamieSlome JamieSlome merged commit 06456c2 into main Aug 3, 2023
2 checks passed
@JamieSlome JamieSlome deleted the 177-revamp-the-readmemd-with-a-lick-of-paint branch August 3, 2023 15:00
coopernetes pushed a commit to coopernetes/git-proxy that referenced this pull request Oct 13, 2023
@JamieSlome
Merge pull request finos#179 from finos/177-revamp-the-readmemd-with-…
3654eb1 
…a-lick-of-paint

Revamp the `README.md` with a lick of paint 🎨
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maoo maoo maoo approved these changes

@TheJuanAndOnly99 TheJuanAndOnly99 Awaiting requested review from TheJuanAndOnly99

Assignees

@JamieSlome JamieSlome

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Revamp the README.md with a lick of paint 🎨
2 participants
@JamieSlome @maoo