devShell hook that gives contribution information #257

New issue

Closed

opened 2024-04-30 22:32:01 +00:00 by jade · 2 comments

jade commented

2024-04-30 22:32:01 +00:00

Owner

relevant meeting notes copy pasta'd:

Contributing Policy

Kate: this should be liftable from somewhere?
- jade + Irides: what is a contributing policy?
- Kate: it's the set of expectations we have for contributors
We already have some stuff on the wiki
- jade: Should do some crosslinking between CONTRIBUTING.md and the wiki
- jade: Maybe find a user to experiment on
Irides: a lot of contributor documentation is not very good
- Raito: nixpkgs mood
- We should have good onboarding process documentation
- puck: we may be conflating "how to use our tooling" and "what kind of contributions are we accepting"
  - External contributors should probably be aware that we're not generally making large changes right now
  - Irides: the wiki already has a document on that
  - jade: ideally before you write a single line of code you should know this information
  - Osiria & jade: a clone/devShell/pre-commit hook that informs the user of our freeze-state
  - Raito & Irides: this is largely a social problem
  - jade: can we put the contributing channel in the devshell hook or something?
    - osiria & irenes: explicitly say "we want to talk to you", link to the channel
    - puck: put CL push webhook into a room maybe? not necessarily now. generates sense of activity
    - kate: specific dedicated channel for "prospective contributors/feedback"
    - puck: concerned about discussion fragmentation with many channels
- jade: how do we MAKE people read the "freeze policy" or so
- jade: should there be synchronization between contributing document and the wiki (probably with repo as source of truth)?
jade: if the contribution document just links to the wiki, you force people to go the wiki
- if it has a bunch of links to the wiki in a separate document, no one will read the links
- maybe should just be a summary
- kate: "ask first, we will help you, here is where to ask"

TL;DR: we want the devShell to tell new prospective contributors that we are not operating as a typical open source project and that we are very willing to talk to them, and that they should probably talk to us before they start writing code at all to avoid heartbreak on the part of everyone involved. relevant meeting notes copy pasta'd: ### Contributing Policy - Kate: this should be liftable from somewhere? - jade + Irides: what is a contributing policy? - Kate: it's the set of expectations we have for contributors - We already have some stuff on the wiki - jade: Should do some crosslinking between CONTRIBUTING.md and the wiki - jade: Maybe find a user to experiment on - Irides: a lot of contributor documentation is not very good - Raito: nixpkgs mood - We should have good onboarding process documentation - puck: we may be conflating "how to use our tooling" and "what kind of contributions are we accepting" - External contributors should probably be aware that we're not generally making large changes right now - Irides: the wiki already has a document on that - jade: ideally before you write a single line of code you should know this information - Osiria & jade: a clone/devShell/pre-commit hook that informs the user of our freeze-state - Raito & Irides: this is largely a social problem - jade: can we put the contributing channel in the devshell hook or something? - osiria & irenes: explicitly say "we want to talk to you", link to the channel - puck: put CL push webhook into a room maybe? not necessarily now. generates sense of activity - kate: specific dedicated channel for "prospective contributors/feedback" - puck: concerned about discussion fragmentation with many channels - jade: how do we MAKE people read the "freeze policy" or so - jade: should there be synchronization between contributing document and the wiki (probably with repo as source of truth)? - jade: if the contribution document just links to the wiki, you force people to go the wiki - if it has a bunch of links to the wiki in a separate document, no one will read the links - maybe should just be a summary - kate: "ask first, we will help you, here is where to ask"

jade added the

devx

label 2024-04-30 22:32:01 +00:00

jade added this to the Soft Launch project 2024-04-30 22:32:01 +00:00

ktemkin self-assigned this 2024-05-02 04:19:44 +00:00

qyriad was assigned by ktemkin

2024-05-02 04:19:44 +00:00

ktemkin commented

2024-05-05 19:51:42 +00:00

Owner

Done! Thanks @qyriad.

ktemkin closed this issue

2024-05-05 19:51:42 +00:00

qyriad commented

2024-05-05 19:54:59 +00:00

Owner

CL: https://gerrit.lix.systems/c/lix/+/996
Commit: 10c1081b88

We::Qyriad really need to stop forgetting to put the "Closes" tags in our commit messages

CL: https://gerrit.lix.systems/c/lix/+/996 Commit: 10c1081b88dfd146fd50053992b262b2cc2bcf37 We::Qyriad really need to stop forgetting to put the "Closes" tags in our commit messages

No milestone

No project

No assignees

3 participants

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: lix-project/lix#257

No description provided.