Skip to content

Commit ef2d71e

Browse files
authored
Merge pull request #225 from plotly/even-better-contributing
Even better contributing guidelines
2 parents 4dd389d + 9892691 commit ef2d71e

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ releasing.
7676
### step 1
7777

7878
Make sure the [unit tests][jltest] and [CircleCI integration tests][circlecI]
79-
are passing.
79+
are passing off the `dev` branch.
8080

8181
### step 2
8282

@@ -89,7 +89,10 @@ For consistency, name the PR: "Release X.Y.Z"
8989
Bump the `version` field in the `Project.toml` (following [semver][semver]) and then
9090

9191
```sh
92+
git checkout dev
93+
git pull origin dev
9294
git commit -m "X.Y.Z"
95+
git push
9396
```
9497

9598
**N.B.** use `X.Y.Z` not `vX.Y.Z` in the commit message, the leading `v` is
@@ -131,8 +134,8 @@ git push --tags
131134
Go the [release page][releases] and create a new release,
132135
name it "Version X.Y.Z" for consistency and fill out sections:
133136

134-
- _What's Changed_, which should include items for all the PRs merged since the last release
135-
- _New Contributor_, which should include mention of all the first-time contributors
137+
- (usually) _Added_, _Changed_, _Fixed_ while including links to the PRs merged since the last release
138+
- _New Contributor_, which should include mentions for all the first-time contributors
136139

137140
finally, place a [GitHub compare link][compare] between the last release and X.Y.Z
138141
e.g. this [one][ex-diff].

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ Built on top of Plotly.js, React and HTTP.jl, [Dash](https://plotly.com/dash/) t
1111

1212
Just getting started? Check out the [Dash for Julia User Guide](https://dash.plotly.com/julia)! If you can't find documentation there, then check out the unofficial [contributed examples](https://github.com/plotly/Dash.jl/issues/50) or check out source code from [demo applications](https://dash.gallery) in Python and then reference the Julia syntax style.
1313

14+
## Other resources
15+
16+
* <https://community.plotly.com/c/plotly-r-matlab-julia-net/julia/23>
17+
* <https://discourse.julialang.org/tag/dash>
18+
1419
## Project Status
1520

1621
Julia components can be generated in tandem with Python and R components. Interested in getting involved with the project? Sponsorship is a great way to accelerate the progress of open source projects like this one; please feel free to [reach out to us](https://plotly.com/consulting-and-oem/)!

0 commit comments

Comments
 (0)