Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
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#17096 (comment)
I 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.
# fork the matplotlib repository to your usernamegit clone git@github.com/your-user-name/matplotlib.gitcd matplotlibgit remote add upstream https://github.com/matplotlib/matplotlib.git# Install dependenciesconda env create -f environment.ymlconda activate mpl-devpre-commit installpip install -e.# checkout a new feature branchgit checkout -b my-new-feature# Make changes to files (including new tests!) and test your additionpytest lib/matplotlib/tests/test_file_you_changed.py# Commit with a message explaining what you have changedgit add any-files-you-changedgit commit# Committing will run automatic code-style checks and may fail and explain what you need to change# Push to remote repositorygit push --set-upstream origin my-new-feature# Go to GitHub and open a Pull Request for your new feature!