Title: Create page with advice for writing a third party package · Issue #18496 · matplotlib/matplotlib · GitHub
Open Graph Title: Create page with advice for writing a third party package · Issue #18496 · matplotlib/matplotlib
X Title: Create page with advice for writing a third party package · Issue #18496 · matplotlib/matplotlib
Description: Problem There is low discoverability for several things that would make life easier for a third party package developer. For example, I had no idea what a trove classifier even was until it was suggested to me here mpl-extensions/mpl-int...
Open Graph Description: Problem There is low discoverability for several things that would make life easier for a third party package developer. For example, I had no idea what a trove classifier even was until it was sug...
X Description: Problem There is low discoverability for several things that would make life easier for a third party package developer. For example, I had no idea what a trove classifier even was until it was sug...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/18496
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Create page with advice for writing a third party package","articleBody":"\u003c!--To help us understand and resolve your issue, please fill out the form to the best of your ability.--\u003e\r\n\u003c!--You can feel free to delete the sections that do not apply.--\u003e\r\n\r\n### Problem\r\n\r\nThere is low discoverability for several things that would make life easier for a third party package developer. For example, I had no idea what a trove classifier even was until it was suggested to me here https://github.com/ianhi/mpl-interactions/issues/25. I also didn't know that it was ok for me to try to advertise via matplolib (e.g. 3rd party packages page, `@matplotlib` on twitter)\r\n\r\nUnderstanding copywrite can also be tricky, for example see this [discourse conversation](https://discourse.matplotlib.org/t/docs-for-a-method-wrapping-a-matplotlib-method/21055/4?u=ianhi)\r\n\r\n### Suggested Improvement\r\n\r\nCreate a `Creating A Third Party Package` page on the docs. Here's an initial list of topics I think would be helpful:\r\n\r\n\r\n**practical**\r\n- practical copyright rules\r\n - If it were homework and you didn't acknowledge would it be cheating?\r\n - If yes then .... (e..g add a comment and include a license file in ___ folder)\r\n- point out that [pytest-mpl](https://github.com/matplotlib/pytest-mpl) exists\r\n- admonish the use of matplotlib private methods\r\n- information on how to passing through docstrings from https://discourse.matplotlib.org/t/docs-for-a-method-wrapping-a-matplotlib-method/21055\r\n- link to, or subsume, https://colcarroll.github.io/yourplotlib/\r\n\r\n**communication**\r\n- Encourage tweeting about your package to `@matplotlib`\r\n - Link to https://github.com/matplotlib/governance/blob/master/communications_guidelines.md for full explanation\r\n- Explain the standard for inclusion in the third-party-packages list/encourage or discourage this\r\n- Mention the 3rd party packages section on discourse\r\n - Provide an example questions issue template redirecting questions there? (Mine is [here](https://github.com/ianhi/mpl-interactions/blob/master/.github/ISSUE_TEMPLATE/question.md))\r\n\r\nping @story645 ","author":{"url":"https://github.com/ianhi","@type":"Person","name":"ianhi"},"datePublished":"2020-09-16T03:06:33.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":6},"url":"https://github.com/18496/matplotlib/issues/18496"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:5138a550-d730-7f79-16e6-5a4295c7d5c2 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9D02:155B49:79AEBC:AC9E41:6A50CC4D |
| html-safe-nonce | b961fd0b3cb8cd20de6a8c119a5395528ebf1ca3ad6a53dfbe6f311e0b6b3b0f |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RDAyOjE1NUI0OTo3OUFFQkM6QUM5RTQxOjZBNTBDQzREIiwidmlzaXRvcl9pZCI6IjQ5NzA5ODI5ODI1MzE3MzA1MTAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | f0c9c0f0d9864cad9c82147288f65a65a0b7674b1d14d0217d75fc8c29053757 |
| hovercard-subject-tag | issue:702410744 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/matplotlib/matplotlib/18496/issue_layout |
| twitter:image | https://opengraph.githubassets.com/fa834a064c992b72f910f2c328a77b7a4313a136fa68d1bad30f0dfc3ad10047/matplotlib/matplotlib/issues/18496 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/fa834a064c992b72f910f2c328a77b7a4313a136fa68d1bad30f0dfc3ad10047/matplotlib/matplotlib/issues/18496 |
| og:image:alt | Problem There is low discoverability for several things that would make life easier for a third party package developer. For example, I had no idea what a trove classifier even was until it was sug... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | ianhi |
| hostname | github.com |
| expected-hostname | github.com |
| None | 72b13e0e8d0319acdd27a145cfe73f4f06c791713d0ac4690e41fb68ad28cac0 |
| turbo-cache-control | no-preview |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 08e79d53fc070870d5b168356afebb1e286a2ffe |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width