Initial setup by acolombier · Pull Request #1 · mixxxdj/proposals

acolombier · 2024-03-24T10:43:18Z

Initial repo setup as per showcased in the demo repo

acolombier · 2024-03-24T11:05:29Z

+
+## Current Proposals
+
+* The [open PRs with the `proposal` label](https://github.com/mixxxdj/proposals/pulls?q=is%3Aopen+is%3Apr+label%3Aproposal) show all the pending proposals.


@mixxx/developer could you please create the proposal label please?

Sure, but aren't all PRs proposals?

I guess not. Some PRs maybe related to chores on the repo (like this one) or updates on previously approved proposal (e.g task list or status update, owner, etc...)

Done, and deleted all others.

daschuer · 2024-03-24T11:48:18Z

+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Markdown formatting and link checking.


What is the advantage of mdox?

I think a pre-commit solution like in mixxxdj/mixxx works better, because the it will be formatted correctly on the side using the known workflow.
There is also a link checker hook available.

Agreed, I would also prefer pre-commit hook, but simply took what was currently setup in the template repo. Will look at replacing it.

I have used markdownlint-cli2 which I often use as it is quite flexible. Let me know if you had another in mind.

daschuer · 2024-03-24T11:59:50Z

+
+## Current Proposals
+
+* The [open PRs with the `proposal` label](https://github.com/mixxxdj/proposals/pulls?q=is%3Aopen+is%3Apr+label%3Aproposal) show all the pending proposals.


Sure, but aren't all PRs proposals?

daschuer · 2024-03-24T12:17:54Z

+## Current Proposals
+
+* The [open PRs with the `proposal` label](https://github.com/mixxxdj/proposals/pulls?q=is%3Aopen+is%3Apr+label%3Aproposal) show all the pending proposals.
+* The [proposals directory](./proposals) shows all the accepted proposals. See the “Implementation Status” for details on the implementation.


Some thought, for adjusting the workflow a bit.

The workflow proposed here, does not allow to "publish" a draft and collaborate before it is ready. You will have a proposal owner, which may accept suggestions until the proposal is "accepted." This makes it hard when you for instance have a good idea, but no interest or time to actually implement it.

After merge, an Owner without commit rights is no longer "Owner" other may hijack the proposal. This will not happen if the proposal is developed in the Owners repository and is only reflected as a PR in this repository.

Currently we don't have a workflow for "accepting" a proposal. It is implicit accepted once you find a contributor and a reviewer for it. Both may collaborate on a proposal. How can we model this workflow?

I think a proposal should be also a place to sort thoughts.

In the past we had design discussions along PRs which in turn required extra work. My hope is that a proposal avoids it.
This requires that objections a phrased early. How can we archive this?

Any ideas how we can reflect these topics as well?

the PR process is how proposals are discussed and accepted. When they are merged, the proposals are accepted

I think the idea of the Owner here is someone who cares about driving the effort to make the proposal happen. It's isn't necessary the initial contributor (e.g cases where the original idea gets abandonned and re-openned by someone else, or case where one ask for a feature but doesn't have the time, knowledge or skills to make the idea happened).

This owner will help with:

informing on changes on the initial plans, in case things gets adjusted after accepting a proposal

facilitating contacts (e.g on Zulip)

crediting the original effort on driving the change.

The advantage of writing down the owner(s) in the document is to prevent cases where the commit authors isn't the original author (as you suggested with a "hijack": this would likely lead to second owner being added, working in collaboration with the original owner, or replacing in case the former owners have lost interest in driving the feature.

Finally, "accepting" doesn't mean having the feature ready and implmented in Mixxx, but rather agreeing on making the proposal happen as time goes. For example, if the proposal repo was here at that time, the QML proposal would have already being accepted (merged) although the development effort is still ongoing. This is a way to say "Mixxx is committed to modernising the UI using QML". Does that make sense? Do you think further info should go in the README.md?

@daschuer do you understand the process now or is the wording still confusing?

ywwg

@acolombier let's get this in soon. If Daniel doesn't have time to review again I think we can merge it in and make tweaks later, but let's get the ball rolling. There is one good note to address and then we can merge.

ywwg

@acolombier let's get this in soon. If Daniel doesn't have time to review again I think we can merge it in and make tweaks later, but let's get the ball rolling. There is one good note to address and then we can merge.

acolombier · 2024-04-22T15:20:17Z

@acolombier let's get this in soon.

Sounds good to me! Apologies I haven't addressed this sooner. I just sorted the major bits (pre-commit and CI) so hopefully we are in good state now to get this in.

Swiftb0y

couple questions, LGTM apart from that.

Swiftb0y · 2024-05-17T17:36:42Z

should this template go into ./proposals or stay here at the root?

I agree, the template should go in /proposals

and be renamed to YYYY-MM-DD_template.md

Swiftb0y · 2024-05-17T17:39:31Z

+2. Create a GitHub Pull Request with a design document in markdown format to the [proposals directory](./proposals).
+   Make sure to use the [template](0000-00-00_template.md) as the guide for what sections should be present in the
+   document. Put the creation date (the day you started preparing this design document) as the prefix and some unique
+   name as the suffix in the file name. Once the PR is proposed, a maintainer will assign a `proposal` label.


it's not clear what the resulting file should be named. I assume 0000-00-00 is YYYY-MM-DD? Does it make sense to track? What date would that be, date of merge/acceptance or initial creation?

From the README, it currently says:

Put the creation date (the day you started preparing this design document)

I think that makes sense as it is a way to track how long the effort has been going on.

Ah, must've missed that. LGTM

ywwg · 2024-05-20T13:46:04Z

@acolombier do you have time to address the last notes? let's get this in! we can also iterate once it's set up.

Co-authored-by: Owen Williams <owen-github@ywwg.com>

acolombier · 2024-05-20T14:40:47Z

@ywwg Done!

Swiftb0y

I don't have a strong opinion on where the template lives. Its fine if it stays at the root so its easier to spot for people

Swiftb0y · 2024-05-20T16:17:20Z

Thank you for putting in the effort to set this up @acolombier

acolombier force-pushed the feat/initial-setup branch 2 times, most recently from 424eca8 to f1b0f3c Compare March 24, 2024 10:45

feat: initial setup

6519620

acolombier force-pushed the feat/initial-setup branch 2 times, most recently from 81ba0db to f1b0f3c Compare March 24, 2024 11:02

feat: initial setup

7db3270

acolombier force-pushed the feat/initial-setup branch from f1b0f3c to 7db3270 Compare March 24, 2024 11:04

acolombier commented Mar 24, 2024

View reviewed changes

daschuer requested changes Mar 24, 2024

View reviewed changes

ywwg approved these changes Apr 1, 2024

View reviewed changes

Replace mdox with pre-commit and various improvement

65f5667

ywwg requested changes Apr 22, 2024

View reviewed changes

Replace mdox with pre-commit and various improvement

69f6bf6

acolombier force-pushed the feat/initial-setup branch from 1563b02 to 69f6bf6 Compare April 22, 2024 15:18

acolombier requested review from daschuer and ywwg April 22, 2024 15:20

ywwg approved these changes Apr 22, 2024

View reviewed changes

acolombier mentioned this pull request May 17, 2024

Ability for controller to share data at runtime mixxxdj/mixxx#12199

Closed

2 tasks

Swiftb0y reviewed May 17, 2024

View reviewed changes

ywwg reviewed May 20, 2024

View reviewed changes

Comment thread README.md Outdated

Change date format to be more explicit

a59665d

Co-authored-by: Owen Williams <owen-github@ywwg.com>

Swiftb0y approved these changes May 20, 2024

View reviewed changes

ywwg merged commit e29c72f into mixxxdj:main May 20, 2024


		## Current Proposals

		* The [open PRs with the `proposal` label](https://github.com/mixxxdj/proposals/pulls?q=is%3Aopen+is%3Apr+label%3Aproposal) show all the pending proposals.

Conversation

acolombier commented Mar 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ywwg left a comment

Choose a reason for hiding this comment

Uh oh!

ywwg left a comment

Choose a reason for hiding this comment

Uh oh!

acolombier commented Apr 22, 2024

Uh oh!

Swiftb0y left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

acolombier May 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ywwg commented May 20, 2024

Uh oh!

Uh oh!

acolombier commented May 20, 2024

Uh oh!

Swiftb0y left a comment

Choose a reason for hiding this comment

Uh oh!

Swiftb0y commented May 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

acolombier commented Mar 24, 2024 •

edited

Loading

acolombier May 20, 2024 •

edited

Loading

Swiftb0y commented May 20, 2024 •

edited

Loading