Code Monkey home page Code Monkey logo

ldk-review-club's Introduction

ldk-review-club

Simple Jekyll site for hosting the LDK PR Review club at https://ldk.reviews/. Based on the work by Bitcoin Core PR Review club.

Development

You'll need Ruby and Jekyll to run the site locally. Ruby 3.0 is recommended. Once they are set up:

  • Clone the repository and go into the directory
  • Run bundle install
  • Run make preview
  • Go to http://localhost:4000

In case of any issues, don't hesitate to run the following to update rubygems, bundler, and dependencies: gem update --system && gem update && bundle update

Making a new post

See the hosting.md doc for how to create a post for an upcoming meeting.

Changing Site Data

All site configurations are either contained in _config.yml or _data/settings.yml. Some data is duplicated between the two due to the way Jekyll injects variables, so be sure to update both.

Running the Test Suite

To run all tests: rake test or just rake

To run one test file: rake TEST=test/test_rake_posts_new

To run an individual test in a test file: rake TEST=test/test_rake_posts_new TESTOPTS=--name=test_rake_posts_new

Before running tests for the first time, you may need to run bundle update.

Before running the test_all_links test (or all of the tests, which includes it), the site needs to be started up locally with make preview, or with make clean preview if any meeting logs were changed, to pre-render the logs through the auto_logs_markup plugin.

Attributions

Thanks to LeNPaul for the Jekyll starter kit this was forked from and to Will O'Beirne for pointing me in that direction.

ldk-review-club's People

Contributors

ariard avatar dunxen avatar jbesraa avatar jkczyz avatar vincenzopalazzo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

ldk-review-club's Issues

Marking the LDK review club maintenance "Up for grabs"

Originally the LDK review club was scheduled to happen biweekly on Tuesday at 6pm UTC and I was taking part to the hosting maintenance. I won't have time to host any review sessions during the coming years so marking "up for grabs" the LDK review club hosting. Beyond, I don't think I do have the qualities of patience and calmness required to be a good teacher so any other active contributor to LDK will be a better fit than myself.

This is not a high commitment bar -- You can count 2/3 hours only of your time to prepare a session. Further it's a great opportunity to stay up-to-date on the significant works happening in LDK and in Lightning. Maintenance could be also shared between many contributors at it's done for the Bitcoin Core review club one. The communication infrastructure is already ready.

Improvements to the review club format

We have been running the review club for a bit and we would like to increase the engagement and hear from everyone what could be improved in order to make the sessions more accessible and attractive.

Currently the session is running on every second Friday and the sessions are usually published here https://ldk.reviews/ beforehand. The sessions run in a chat format in the LDK discord channel.

The main goal of the sessions is to allow new contributors to raise questions and get a the chance to discuss the merits of a PR with with other developers and get more confidence to contribute to the code base in the future.

A few suggestions were discussed while at Advancing Bitcoin:

  1. Have voice sessions instead of chat(Can be potentially transcribed on the go by the platform we would use)
  2. Change the current time as its more tricky for EU/Asia based participants to join on Friday evening
  3. Allow participants to decide whats the session about

I would love to hear what you guys think and how we can improve these sessions.

cc @jkczyz

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.