You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/contributing.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -186,7 +186,7 @@ Many people have trouble with Git. More have trouble with Github. I think much
186
186
Here are some guidelines for the development workflow (Note: Even if you've made 20 PRs to Plots in the past, please read this as it may be different than past guidelines):
187
187
188
188
-**Commit to a branch that belongs to you.** Typically that means you should give your branches names that are unique to you, and that might include information on the feature you're developing. For example, I might choose to `git checkout -b tb-fonts` when starting work on fonts.
189
-
-**Open a PR against master.**`master` is the "bleeding edge". (Note: I used to recommend `PR`ing to `dev`)
189
+
-**Open a PR against the development branch (can be `master`or `v2`), where `v2`is the "bleeding edge".
190
190
-**Only merge others changes when absolutely necessary.** You should prefer to use `git rebase origin/master` instead of `git merge origin/master`. A rebase replays your recent commits on top of the most recent `master`, avoiding complicated and messy merge commits and generally avoiding confusion. If you follow the first rule, then you likely won't get yourself in trouble. Rebase horror stories generally result when many people are working on the same branch. I find [this resource](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) is great for understanding the important parts of `git rebase`.
191
191
192
192
---
@@ -243,7 +243,7 @@ Power up your favorite editor (maybe [Juno](https://junolab.org/)?) and make som
243
243
244
244
Format your changes (code style consistency) using:
245
245
```bash
246
-
$ julia -e 'using Runic; exit(Runic.main(ARGS))'
246
+
$ julia -e 'using Runic; exit(Runic.main(ARGS))' -- --inplace .
247
247
```
248
248
249
249
#### Commit
@@ -291,6 +291,18 @@ The version number (vMAJOR.MINOR.PATCH) should be incremented using [semver](htt
291
291
292
292
### Testing
293
293
294
+
Testing individual `Plots` components suche as `PlotsBase` is as simple as :
295
+
```bash
296
+
$ cd Plots.jl/PlotsBase
297
+
$ julia --project=. -e 'using Pkg; Pkg.test()'
298
+
```
299
+
300
+
, or for `RecipesBase` :
301
+
```bash
302
+
$ cd Plots.jl
303
+
$ julia --project=RecipesBase -e 'using Pkg; Pkg.test()'
304
+
```
305
+
294
306
#### VisualRegressionTests
295
307
296
308
Testing in Plots is done with the help of [VisualRegressionTests](https://github.com/JuliaPlots/VisualRegressionTests.jl). Reference images are stored in [PlotReferenceImages](https://github.com/JuliaPlots/PlotReferenceImages.jl). Sometimes the reference images need to be updated (if features change, or if the underlying backend changes). VisualRegressionTests makes it somewhat painless to update the reference images:
0 commit comments