From d99b6439a4837822dd713639a07f4783199ff5df Mon Sep 17 00:00:00 2001 From: Talley Lambert Date: Mon, 4 Dec 2023 15:09:51 -0500 Subject: [PATCH] update contrib --- .gitignore | 1 + CONTRIBUTING.md | 9 ++++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index f87eb1c51..9857fe4b2 100644 --- a/.gitignore +++ b/.gitignore @@ -131,3 +131,4 @@ dmypy.json # Pycharm .idea/ +examples/desktop/diffs/*.png diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bf5c69ea..23810b956 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Contributions are welcome! :smile: ![image](https://github.com/kushalkolar/fastplotlib/assets/9403332/82612021-37b2-48dd-b7e4-01a919535c17) -2. Clone the repo and install according to the development instructions. Replace the `YOUR_ACCOUNT` in the repo URL to the fork on your account: +2. Clone the repo and install according to the development instructions. Replace the `YOUR_ACCOUNT` in the repo URL to the fork on your account. Note that fastplotlib uses [git-lfs](https://git-lfs.com) for storing large files, so you will need to [install it](https://github.com/git-lfs/git-lfs#installing) before cloning the repo. ```bash git clone https://github.com/YOUR_ACCOUNT/fastplotlib.git @@ -18,11 +18,14 @@ cd fastplotlib pip install -e ".[notebook,docs,tests] ``` +> If you cloned before installing `git-lfs`, you can run `git lfs pull` at any +> time to properly download files. + 3. Checkout the `main` branch, and then checkout your feature or bug fix branch, and run tests: > **Warning** -> Do not commit or add any changes from `examples/screenshots` or `examples/diffs`. -> If you are creating new test examples that generate or change screenshots please post an issue on the repo and we will help you. The screenshots will be generated on github actions servers, which you can then copy into the screenshots dir. :) +> Do not commit or add any changes from `examples/desktop/screenshots`. +> If you are creating new test examples that generate or change screenshots please post an issue on the repo and we will help you. The screenshots will be generated on github actions servers, which you can then copy into the screenshots dir. :) ```bash cd fastplotlib pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy