Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create initial project governance docs #674

Merged
merged 3 commits into from
Jan 10, 2023
Merged

create initial project governance docs #674

merged 3 commits into from
Jan 10, 2023

Conversation

droumis
Copy link
Member

@droumis droumis commented Jan 3, 2023

The files in this pull request should act as examples of how other HoloViz projects could quickly adopt the default project docs using references to the project docs at holoviz/holoviz.

The maintainer list is based on the HoloViz Duties spreadsheet. All three maintainers should participate and/or approve.

I'll mention this at the next docs meeting, but I've written the guidance to create project docs. I'll update this if there are any further changes to this PR.

Copy link
Member

@jbednar jbednar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Should we maybe have a tag like param-governance on the holoviz repo, so that these documents could point to that tag as an unambiguous version, but then we could move that tag whenever we wanted to inherit the new changes from holoviz?

@jlstevens
Copy link
Contributor

Looks good to me!

Should we maybe have a tag like param-governance on the holoviz repo, so that these documents could point to that tag as an unambiguous version, but then we could move that tag whenever we wanted to inherit the new changes from holoviz?

A tag is a good idea though if we want to point to a different version for different projects then yes, we will need a <project>-governance tag for every project. Still probably better than pointing to an obscure SHA.

@droumis
Copy link
Member Author

droumis commented Jan 5, 2023

Should we maybe have a tag like param-governance on the holoviz repo, so that these documents could point to that tag as an unambiguous version, but then we could move that tag whenever we wanted to inherit the new changes from holoviz?

I've never done something like this, but I assume that in order to use a consistent param-gov-tagged link like https://github.com/holoviz/holoviz/blob/param-gov/file.md (not a real link) which starts on commit 'A', then when it is time to update the param-gov tag to a more recently committed version of this document, commit 'B', then someone with merge permissions for holoviz/holoviz repo would have to first delete the tag from the commit 'A' and then push the tag to 'commit B'.

I'm not a maintainer for param so don't consider this a blocker, but I'm not sure I agree with this approach since the history of such a reference update would not live within the Param repo. Alternatively, an update to the SHA links would just be a matter of updating 4 such links and the history would be a pull request within the Param repo (and I imagine that this would happen pretty rarely)

@jbednar
Copy link
Member

jbednar commented Jan 5, 2023

Moving a git tag should be straightforward for any holoviz maintainer.

We're already depending on an external repo, because the explicit sha being referenced currently has no meaning outside of the external repo. It's true that it's not difficult to replace the sha in four files, but it is difficult to know how many files, and which ones, need to be updated. Each time we need to do that there will be an investigation where we find an original PR like this or grep the repo for that sha or something of the like, all to make a trivial change.

I do agree that it's helpful to have a history of the governance versions, and moving a tag doesn't immediately provide such a history, which is a downside. But as we indeed don't expect many changes to the governance, and generally look forward rather than backward, I'd favor having it be straightforward and obvious how to update to the latest version from holoviz, rather than optimizing for preserving past links. Other maintainers, please weigh in if you disagree or have a better suggestion, and not just for Param but for other HoloViz projects, as it would be best to handle them all similarly by default.

@droumis droumis self-assigned this Jan 9, 2023
Copy link
Member

@philippjfr philippjfr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@droumis droumis added this to the v1.12.x milestone Jan 9, 2023
@droumis
Copy link
Member Author

droumis commented Jan 10, 2023

param-gov tag has been created and I've updated the links in this PR and the instructions on the google doc linked in the description at the top. I'll merge now

@droumis droumis merged commit e71f75e into main Jan 10, 2023
@droumis droumis deleted the gov branch January 10, 2023 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants