Giter VIP home page Giter VIP logo

contribcard's Introduction

ContribCard

ContribCard is a tool that generates cards for your projects contributors. You can see a live demo here.

At the moment some parts (i.e. UI) are mostly focused on Kubernetes (to celebrate the Kubernetes 10th anniversary!), but we have plans to make it configurable so that the tool can be easily used by other projects. As soon as this is ready we'll provide some more documentation to explain how the tool works and how to install and use it.

Warning

ContribCard is at an early stage of development. There may be breaking changes in the future to the command usage, flags, and configuration file formats.


Contributing

Please see CONTRIBUTING.md for more details.

Code of Conduct

This project follows the CNCF Code of Conduct.

License

ContribCard is an Open Source project licensed under the Apache License 2.0.

contribcard's People

Contributors

cynthia-sg avatar tegioz avatar tisonkun avatar caniszczyk avatar

Stargazers

tomsun28 avatar  avatar Yuchen Cheng avatar Will Hegedus avatar Iliyan Petkov avatar Orlix avatar Yan Borowski avatar Daniel Krook avatar Jscar Hawk avatar Lukas Reining avatar Tuomo Tanskanen avatar Amin Ullah Kàsi & Barak © avatar Caleb Woodbine avatar  avatar Nikolay Dubina avatar Jongwoo Han avatar Kevin Park avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

contribcard's Issues

Improve "serve" user experience

Then I have an idea to improve the UX here, we can either:

  1. Require to specify --content-dir
  2. Warning on fallback to env::current_dir() and print what the current_dir resolve to
  3. Warning or error on let index_path = content.join("index.html"); is not exist with more precise message.

No worries!

Option 2 sounds good to me. Maybe an info line displaying the content_dir we are using to serve content from is enough.

Originally posted by @tegioz in #51 (comment)

Speed up for single user query

IIUC the current build logic iter over all the repos in the organizations configured and even all the commits in those repos.

If I'd make a card for a single user, is it possible to add a fast path? Or this repo is just for build a global dataset and then host the website based by those preset?

Make ContribCard social messages configurable via config file

It’s not configurable from a config file yet, but you can update it directly in the code for now:

<meta property="og:description" content="Happy #kuberTENes! Check out my #FirstContribution to Kubernetes https://contribcard.clotributor.dev" />

export const DESCRIPTION = `Happy #kuberTENes! Check out my #FirstContribution to Kubernetes`;
export const HASHTAGS = ['kuberTENes', 'FirstContribution'];

Incomplete contributions

Somehow majority of my contributions is missing on contribcard. E.g. I'm sure I contributed at least 5 more PRs on the spire repo. And even more on the spire helm charts.

404 on serve

Reproduce:

# Clone the code, and ...
$ cargo build --release
$ ./target/release/contribcard serve
2024-06-13T00:41:01.554386Z  INFO serve: contribcard::serve: http server running (press ctrl+c to stop)

🔗 contribcard available at: http://127.0.0.1:8000
$ curl -i -X GET  http://127.0.0.1:8000
HTTP/1.1 404 Not Found
Connection: keep-alive
Date: Thu, 13 Jun 2024 00:41:13 GMT
Keep-Alive: timeout=4
Proxy-Connection: keep-alive
Content-Length: 0

Anything I forget to set or configure?

Add LinkedIn to social sharing

We should support LinkedIn too.

Twitter/X + LinkedIn will be the most popular imho

@tegioz if you can try to get this in by this Friday that would be great

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.