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

🎨 Add new logo to readme #1087

Merged
merged 4 commits into from
Jun 5, 2022
Merged

Conversation

s-weigand
Copy link
Member

@s-weigand s-weigand commented Jun 5, 2022

Follow up PR for #1083 since it is easier to get the correct link when the logo is already in the repo.

So check what the frontpage looks like you can look at this branch on my fork
image
image

Change summary

Checklist

  • ✔️ Passing the tests (mandatory for all PR's)
  • 🚧 Added changes to changelog (mandatory for all PR's)

@github-actions
Copy link
Contributor

github-actions bot commented Jun 5, 2022

Binder 👈 Launch a binder notebook on branch s-weigand/pyglotaran/add-new-logo-to-readme

@s-weigand s-weigand force-pushed the add-new-logo-to-readme branch from c1f5a2d to a3e1f77 Compare June 5, 2022 18:46
@codecov
Copy link

codecov bot commented Jun 5, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.3%. Comparing base (cf859e9) to head (7fe87b8).
Report is 202 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main   #1087   +/-   ##
=====================================
  Coverage   87.3%   87.3%           
=====================================
  Files        102     102           
  Lines       5388    5388           
  Branches     997     997           
=====================================
  Hits        4704    4704           
  Misses       530     530           
  Partials     154     154           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions
Copy link
Contributor

github-actions bot commented Jun 5, 2022

Benchmark is done. Checkout the benchmark result page.
Benchmark differences below 5% might be due to CI noise.

Benchmark diff v0.5.1 vs. main

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [96b42630]       [7fe87b88]
     <v0.5.1>                   
       51.5±0.6ms       57.6±0.6ms    ~1.12  BenchmarkOptimize.time_optimize(False, False, False)
         59.2±1ms        71.4±40ms    ~1.21  BenchmarkOptimize.time_optimize(False, False, True)
         52.9±1ms         57.5±1ms     1.09  BenchmarkOptimize.time_optimize(False, True, False)
         56.5±3ms         63.4±2ms    ~1.12  BenchmarkOptimize.time_optimize(False, True, True)
         62.5±3ms         70.9±2ms    ~1.13  BenchmarkOptimize.time_optimize(True, False, False)
         142±60ms        77.0±30ms    ~0.54  BenchmarkOptimize.time_optimize(True, False, True)
         66.4±1ms         68.6±2ms     1.03  BenchmarkOptimize.time_optimize(True, True, False)
        71.1±10ms         72.4±2ms     1.02  BenchmarkOptimize.time_optimize(True, True, True)
             204M             206M     1.01  IntegrationTwoDatasets.peakmem_optimize
       1.93±0.03s       1.86±0.02s     0.96  IntegrationTwoDatasets.time_optimize

Benchmark diff main vs. PR

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [cf859e9f]       [7fe87b88]
       59.5±0.7ms       57.6±0.6ms     0.97  BenchmarkOptimize.time_optimize(False, False, False)
        62.9±30ms        71.4±40ms    ~1.13  BenchmarkOptimize.time_optimize(False, False, True)
       58.3±0.8ms         57.5±1ms     0.99  BenchmarkOptimize.time_optimize(False, True, False)
         59.9±4ms         63.4±2ms     1.06  BenchmarkOptimize.time_optimize(False, True, True)
         68.6±3ms         70.9±2ms     1.03  BenchmarkOptimize.time_optimize(True, False, False)
        80.0±30ms        77.0±30ms     0.96  BenchmarkOptimize.time_optimize(True, False, True)
         68.8±3ms         68.6±2ms     1.00  BenchmarkOptimize.time_optimize(True, True, False)
        73.5±30ms         72.4±2ms     0.98  BenchmarkOptimize.time_optimize(True, True, True)
             202M             206M     1.02  IntegrationTwoDatasets.peakmem_optimize
       1.88±0.07s       1.86±0.02s     0.99  IntegrationTwoDatasets.time_optimize

Better aligned logo placement
@jsnel
Copy link
Member

jsnel commented Jun 5, 2022

Since it's a logo and not a banner, it should not go full size front and center. So I changed how it's rendered aligned with the rest of the text. At least in markdown to html.

Light
image

Dark
image

Inspiration for alignment here.

Added some descriptive text to explain what one might use the library for.
(this also improves alignment of text and images in the rendered document)
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 5, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.7% 0.7% Duplication

@jsnel jsnel self-requested a review June 5, 2022 19:56
@jsnel jsnel merged commit d16e58e into glotaran:main Jun 5, 2022
@s-weigand s-weigand deleted the add-new-logo-to-readme branch June 6, 2022 13:56
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.

2 participants