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

Draft of a governance doc #1822

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Draft of a governance doc #1822

wants to merge 2 commits into from

Conversation

sgillies
Copy link
Contributor

@sgillies sgillies commented May 23, 2023

Adapted from rasterio's, which is adapted from NumPy's.

This is a follow up on something I wrote at the start of 2023: #1740 (comment).

Adapted from rasterio's, which is adapted from NumPy's.
@sgillies sgillies self-assigned this May 23, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 5062325103

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.3%) to 87.592%

Totals Coverage Status
Change from base Build 5031774366: 0.3%
Covered Lines: 2506
Relevant Lines: 2861

💛 - Coveralls

Copy link
Collaborator

@caspervdw caspervdw left a comment

Choose a reason for hiding this comment

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

Thanks @sgillies for taking this initiative. A landmark in professionalizing Shapely!

I read through it and nothing stands out in particular. Do you have a specific section that needs extra attention?

One thought; when describing what shapely is, it might be good to mention GEOS, as shapely is largely an API around GEOS.

governance.md Show resolved Hide resolved
@sgillies sgillies marked this pull request as ready for review June 6, 2023 21:27
@sgillies
Copy link
Contributor Author

sgillies commented Jun 7, 2023

@caspervdw I was hoping that adapting Numpy's governance doc would be uncontroversial. And I find it to be both practical and philosophical.

As to professionalization: I don't want to take it too far! I'd like Shapely to not depart too much from its punk and DIY roots 😄

@sgillies
Copy link
Contributor Author

sgillies commented Jun 8, 2023

Unrelated to this PR: it looks like we have some flaky tests.

@caspervdw
Copy link
Collaborator

Unrelated to this PR: it looks like we have some flaky tests.

Yep the GEOS main branch often fails because we have lots of super strict tests. I think that’s a good thing but having the red X everywhere is not.
Maybe we should allow the failures against main(and manually check them)

@caspervdw
Copy link
Collaborator

@sgillies are you 👍 on merging this?

Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

Thanks for getting this started! I am very supportive to describing our governance. And generally fine with adapting the NumPy governance documents.

One aspect I am wondering: do we want to say something about "commit rights" (who has those, how to get them, ...), or do we leave that detail to the practical day-to-day organization without being written out? (assuming this is not tied to being Steering Council member). Also the NumPy document doesn't mention this, and I can't directly find where this is described elsewhere for them (they do mention to have teams on their website, and list the "maintainers" members as one of the teams at https://numpy.org/teams/)

Comment on lines +101 to +102
substantive API changes must be posted to the mailing list in order to give the
broader community a chance to catch any problems and suggest improvements; we
Copy link
Member

Choose a reason for hiding this comment

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

This is probably a left-over from numpy, since we don't have a mailing list for shapely (unless we plan to create one?)

In the version we adapted for geopandas, we changes this section a bit to just mention that the GitHub issues/PRs would be left open for a bit longer "to provide greater opportunity for feedback": https://github.com/geopandas/governance/blob/main/Governance.md#consensus-based-decision-making-by-the-community

Comment on lines +250 to +253
[There is no funding today. Institutional partners are the companies that
employ contributors to, in part, work on Shapely. This section is about
defining "Institutional partner", not about enumerating them. We'll borrow from
Jupyter and NumPy.]
Copy link
Member

Choose a reason for hiding this comment

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

Is this intended to stay? (we could add a note that there is currently no funding, but then would clean it up a bit)

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.

None yet

4 participants