Title: DOC: Add conda environment instructions to developers guide · Issue #21611 · matplotlib/matplotlib · GitHub
Open Graph Title: DOC: Add conda environment instructions to developers guide · Issue #21611 · matplotlib/matplotlib
X Title: DOC: Add conda environment instructions to developers guide · Issue #21611 · matplotlib/matplotlib
Description: Just so we don't lose track of adding this to the docs at some point. I'll add a description how to use this later to the dev docs. But basically following the instuctions in the file is sufficient. Originally posted by @timhoffm in #170...
Open Graph Description: Just so we don't lose track of adding this to the docs at some point. I'll add a description how to use this later to the dev docs. But basically following the instuctions in the file is sufficient...
X Description: Just so we don't lose track of adding this to the docs at some point. I'll add a description how to use this later to the dev docs. But basically following the instuctions in the file is su...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/21611
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"DOC: Add conda environment instructions to developers guide","articleBody":"Just so we don't lose track of adding this to the docs at some point.\r\n\r\nI'll add a description how to use this later to the dev docs. But basically following the instuctions in the file is sufficient.\r\n\r\n_Originally posted by @timhoffm in https://github.com/matplotlib/matplotlib/issues/17096#issuecomment-921223344_\r\n\r\nI found reading through the installation instructions quite verbose. I think it is good information to keep in the documentation, but intimidating for someone just coming onto the project. My suggestion would be to add a top-level \"Quickly get set up\" section using the conda environment from the repo and explaining how to install and use pre-commit from #21583. An opinionated set of instructions up front and then additional details for other architectures and configurations following that.\r\n\r\n```bash\r\n# fork the matplotlib repository to your username\r\ngit clone git@github.com/your-user-name/matplotlib.git\r\ncd matplotlib\r\ngit remote add upstream https://github.com/matplotlib/matplotlib.git\r\n\r\n# Install dependencies\r\nconda env create -f environment.yml\r\nconda activate mpl-dev\r\npre-commit install\r\npip install -e .\r\n\r\n# checkout a new feature branch\r\ngit checkout -b my-new-feature\r\n\r\n# Make changes to files (including new tests!) and test your addition\r\npytest lib/matplotlib/tests/test_file_you_changed.py\r\n\r\n# Commit with a message explaining what you have changed\r\ngit add any-files-you-changed\r\ngit commit\r\n# Committing will run automatic code-style checks and may fail and explain what you need to change\r\n\r\n# Push to remote repository\r\ngit push --set-upstream origin my-new-feature\r\n# Go to GitHub and open a Pull Request for your new feature!\r\n```","author":{"url":"https://github.com/greglucas","@type":"Person","name":"greglucas"},"datePublished":"2021-11-12T15:32:45.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":5},"url":"https://github.com/21611/matplotlib/issues/21611"}
| 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:def91f3d-92a4-f097-0e0e-75b95f4ff67a |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | CB0A:2BD65D:29D0C7:383EC3:6A518A0F |
| html-safe-nonce | cec640938860e3c98219ab94998fc8548ea2a12da94dd2058b52c3e5df843ae6 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDQjBBOjJCRDY1RDoyOUQwQzc6MzgzRUMzOjZBNTE4QTBGIiwidmlzaXRvcl9pZCI6IjYzOTk0NjU4OTA4ODMxNDQyMDciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 9d04a23d17d22ffff2debfb479935a5ea5514078490f6549d6eca91d8bfb56b9 |
| hovercard-subject-tag | issue:1052089595 |
| 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/21611/issue_layout |
| twitter:image | https://opengraph.githubassets.com/7b396a515f9c9d707288e8233d2c1486816d0ca355699e4a3e69561994c2a0c3/matplotlib/matplotlib/issues/21611 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/7b396a515f9c9d707288e8233d2c1486816d0ca355699e4a3e69561994c2a0c3/matplotlib/matplotlib/issues/21611 |
| og:image:alt | Just so we don't lose track of adding this to the docs at some point. I'll add a description how to use this later to the dev docs. But basically following the instuctions in the file is sufficient... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | greglucas |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| 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 | cb77a7b8b06cd86c243be33fd8e7922d70a9d243 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width