search

dragonflydb / dragonfly

A modern replacement for Redis and Memcached
https://www.dragonflydb.io/
Other
25.8k stars 950 forks source link

github project enhancements #107

Closed romange closed 2 years ago

romange commented 2 years ago

Something else?

ryanrussell commented 2 years ago

Two suggestions:

1. Adopt conventional commits syntax in PR's/Issues/Commits: https://www.conventionalcommits.org/en/v1.0.0/

Seeing feat(thing): What happened or bug(whatever): Bad thing or docs(readme): Add whatever helps grep faster when the list gets long.

It helps people coming from many different angles/skill/intention to streamline communications and pass them off for handling.

I would personally love my Commits/PR's to look like vector's

image

Believe this would help keep some sanity as you go from a handful of contributors to hundreds.

2. Auto-tagging PR's based on changes in a pre-commit workflow

Little script I saw at Ritchie's wonderful Polars

Leaves you with nice auto-tagging on PR's to visually see delta's

image

romange commented 2 years ago

so (1) is about education (myself included). can we enforce this notion somehow? (2) looks really great but I wonder if it's applicable to this repo, since it's mostly c++ ?

romange commented 2 years ago

btw, vector looks great and its documentation is fantastic.

ryanrussell commented 2 years ago

so (1) is about education (myself included). can we enforce this notion somehow?

I would tweak on this pre-commit hook gist: https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13

It looks like your issues are starting to bloom with core DragonFly issues; I can put this after this docker-compose.yml if you want to adopt conventional commits but don't have cycles.

(2) looks really great but I wonder if it's applicable to this repo, since it's mostly c++ ?

I would apply to docs, examples, tools, tests, etc.. maybe some subfolders within src get special nested tags?

Here's the same commit hook for labels but applied to Vector(Single Lang). I personally like Ritchie's because the color coding; let's you move fast.

You can see how they have setup labels: https://github.com/vectordotdev/vector/blob/master/.github/labeler.yml

image

I would stackrank the labeler below getting the conventional commits implemented.

romange commented 2 years ago

I would love if you could handle this after adding docker-compose. I won't be able to master everything, unfortunately, so covering these areas will be a great help for the project!

ryanrussell commented 2 years ago

@romange

Happy to. If you want to move the bricks and give me the feathers, that's cool.

romange commented 2 years ago

lol. 🤣

did you invent this phrase?! Tried to look it up but did not find anything

romange commented 2 years ago

and to your knowledge, I thrive on passive-aggressive, so totally fine by me 😆

alisaifee commented 2 years ago

A few minor suggestions

ryanrussell commented 2 years ago

@romange @alisaifee

Found two decent clang pre-commit hooks. Thoughts? Other preferences? Is this something you want in your workflow?

This kind of thing should probably be chosen on your side... Should be easy to amend the pre-commit yaml files to add more linting if you like one of these...

https://github.com/pocc/pre-commit-hooks https://github.com/pre-commit/mirrors-clang-format

@romange ... Going to leave the clang linting choices to you :)

romange commented 2 years ago

Opened #200 for formatter hook. Re PR labeling - based on the Pr volume, it's not a problem we need to solve today. Closing this issue as completed.

romange commented 2 years ago

The first choice seems more capable even if we won't use all of its features. Also, it has more stars.

I need to learn this stuff gradually myself.

I use clang-format within vscode and base my code on Google Styleguide with some relaxations (80 chars width in 2022 borders with masochism). But I have not used automation checks before.

On Sat, Jun 11, 2022 at 10:31 AM Ryan Russell @.***> wrote:

@romange https://github.com/romange @alisaifee https://github.com/alisaifee

Found two decent clang pre-commit hooks. Thoughts? Other preferences? Is this something you want in your workflow?

This kind of thing should probably be chosen on your side... Should be easy to amend the pre-commit yaml files to add more linting if you like one of these...

https://github.com/pocc/pre-commit-hooks https://github.com/pre-commit/mirrors-clang-format

@romange https://github.com/romange ... Going to leave the clang linting choices to you :)

— Reply to this email directly, view it on GitHub https://github.com/dragonflydb/dragonfly/issues/107#issuecomment-1152874517, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4BFCFU3KMYZBU6Q3LJFT3VOQ6FLANCNFSM5X7SZVZA . You are receiving this because you were mentioned.Message ID: @.***>