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

docs(readme): add contributors graph image #225

Merged
merged 1 commit into from
Jun 8, 2023
Merged

Conversation

joshka
Copy link
Member

@joshka joshka commented Jun 7, 2023

No description provided.

@codecov
Copy link

codecov bot commented Jun 7, 2023

Codecov Report

Merging #225 (cac0436) into main (d711f2a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #225   +/-   ##
=======================================
  Coverage   81.68%   81.68%           
=======================================
  Files          34       34           
  Lines        6579     6579           
=======================================
  Hits         5374     5374           
  Misses       1205     1205           

Copy link
Member

@mindoodoo mindoodoo left a comment

Choose a reason for hiding this comment

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

I kind of like the idea of potentially keeping the acknowledgement section in addition to the contributors section. What do you think ?

The idea being we can keep special acknowledgements in the acknowledgement section, such as the logo creator, the og maintainer, etc...

@joshka
Copy link
Member Author

joshka commented Jun 7, 2023

The info is there. Just the section name is changed to fit both the image and acknowledgments underneath.

Oops. I'm wrong :)

@orhun
Copy link
Member

orhun commented Jun 7, 2023

I agree with @mindoodoo, let's keep the acknowledgements section.

- Add contributors graph
- Add markdownlint config file
- Reformat README line width to 100
- Add a link to the CHANGELOG
- Remove APPS.md
- Change apps link to the Wiki instead of APPS.md
@joshka
Copy link
Member Author

joshka commented Jun 7, 2023

I moved it back in to an acknowledgment section, reformated to 100 columns, added a markdownlint config, changed the link to the APPs wiki page, removed APPS.md, and added a link to the CHANGELOG (it's always useful being able to find that from the crates.io page).

Copy link
Member

@mindoodoo mindoodoo left a comment

Choose a reason for hiding this comment

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

LGTM, thanks !

@orhun orhun merged commit 9ecc4a1 into ratatui:main Jun 8, 2023
@joshka joshka deleted the readme branch June 10, 2023 04:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants