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
*`CONTRIBUTING.md` - changed `dash-cytoscape-0.0.1` to `dash-cytoscape-x.x.x`. Added a **Code quality & design** section. Changed the **Making a contribution** section and updated title to **Publishing**. Updated **Pre-Release checklist**.
17
+
*`npmignore` - Added `venv` to avoid venvs to be included in the npm distribution package, which makes us a large amount of space and many unnecessary files being distributed.
18
+
19
+
## Removed
20
+
*`extract-meta.js`, `extract-meta` - they were moved to the dash component CLI, thus are not needed anymore
21
+
*`config.py`, `runtime.txt`, `Procfile`, `index.html` - only needed for hosting `usage-*.py` on DDS, they are now moved to `plotly/dash-cytoscape-demos`.
22
+
*`review_checklist.md` - redundant since all the information is already contained in CONTRIBUTING.md
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+42-20Lines changed: 42 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,31 @@ Refer to the [readme](README.md) for installation and development instructions.
8
8
9
9
Please lint any additions to Python code with `pylint` and `flake8`.
10
10
11
-
## Pull Request Guidelines
11
+
## Code quality & design
12
+
13
+
- Is your code clear? If you had to go back to it in a month, would you be happy to? If someone else had to contribute to it, would they be able to?
14
+
15
+
A few suggestions:
16
+
17
+
- Make your variable names descriptive and use the same naming conventions throughout the code.
18
+
19
+
- For more complex pieces of logic, consider putting a comment, and maybe an example.
20
+
21
+
- In the comments, focus on describing _why_ the code does what it does, rather than describing _what_ it does. The reader can most likely read the code, but not necessarily understand why it was necessary.
22
+
23
+
- Don't overdo it in the comments. The code should be clear enough to speak for itself. Stale comments that no longer reflect the intent of the code can hurt code comprehension.
24
+
25
+
* Don't repeat yourself. Any time you see that the same piece of logic can be applied in multiple places, factor it out into a function, or variable, and reuse that code.
26
+
* Scan your code for expensive operations (large computations, DOM queries, React re-renders). Have you done your possible to limit their impact? If not, it is going to slow your app down.
27
+
* Can you think of cases where your current code will break? How are you handling errors? Should the user see them as notifications? Should your app try to auto-correct them for them?
12
28
13
-
Use the [GitHub flow][] when proposing contributions to this repository (i.e. create a feature branch and submit a PR against the master branch).
14
29
15
30
## Running the Tests
16
31
17
32
_To be added_
18
33
19
34
20
-
## Making a contribution
21
-
_For larger features, your contribution will have a higher likelihood of getting merged if you create an issue to discuss the changes that you'd like to make before you create a pull request._
35
+
## Publishing
22
36
23
37
Create a pull request and tag the Plotly team (`@plotly/dash_bio`) and tag / request review from [@xhlulu](https://github.com/xhlulu).
24
38
@@ -39,66 +53,74 @@ python setup.py sdist
39
53
```
40
54
6. Copy the tarball into a separate folder and try to install it and run the examples:
41
55
```
42
-
cp dist/dash-cytoscape-0.0.1.tar.gz ../temp
56
+
cp dist/dash_cytoscape-x.x.x.tar.gz ../temp
43
57
cp usage.py ../temp
44
58
cd ../temp
45
59
source venv/bin/activate
46
-
pip install dash-cytoscape-0.0.1.tar.gz
60
+
pip install dash_cytoscape-x.x.x.tar.gz
47
61
python usage.py
48
62
```
49
63
7. If the examples work, then publish:
50
64
```
51
65
npm publish
52
-
twine upload dist/dash-cytoscape-0.0.1.tar.gz
66
+
twine upload dist/dash_cytoscape-x.x.x.tar.gz
53
67
```
54
68
8. Tag your release with git:
55
69
```
56
-
git tag -a 'v0.0.1' -m 'v0.0.1'
70
+
git tag -a 'vx.x.x' -m 'vx.x.x'
57
71
git push origin master --follow-tags
58
72
```
59
73
9. Verify that the publish worked by installing it:
60
74
```
61
75
cd ../temp
62
-
pip install dash-cytoscape==0.0.1
76
+
pip install dash-cytoscape==x.x.x
63
77
python usage.py
64
78
```
65
79
66
80
67
-
Make a post in the [Dash Community Forum][]
68
-
* Title it `":mega: Announcement! New <Your Feature> - Feedback Welcome"`
69
-
* In the description, link to the PR and any relevant issue(s)
70
-
* Pin the topic so that it appears at the top of the forum for two weeks
81
+
Make a post in the [Dash Community Forum](https://community.plot.ly/c/dash)
82
+
* Title it `":mega: Announcement! New <Your Feature> - Feedback Welcome"`
83
+
* In the description, link to the PR and any relevant issue(s)
84
+
* Pin the topic so that it appears at the top of the forum for two weeks
**Beginner tip:**_Copy and paste this section as a comment in your PR, then check off the boxes as you go!_
74
88
### Pre-Merge checklist
75
-
-[ ] If changes are significant, a release candidate has been created and posted to Slack, the Plotly forums, and at the very top of the pull request.
76
-
-[ ] Two people have :dancer:'d the pull request. You can be one of these people if you are a Dash core contributor.
89
+
-[ ] The project was correctly built with `npm run build:all`.
90
+
-[ ] If there was any conflict, it was solved correctly
91
+
-[ ] All changes were documented in CHANGELOG.md.
92
+
-[ ] All tests on CircleCI have passed.
93
+
-[ ] All Percy visual changes have been approved.
94
+
-[ ] Two people have :dancer:'d the pull request. You can be one of these people if you are a Dash Cytoscape core contributor.
95
+
96
+
### Merge step
97
+
1. Make sure to *Squash and Merge* your contribution if you have created multiple commits to change a specific feature.
98
+
2. Make sure to *Rebase and Merge* if you added many different features, and need to contribute multiple different commits.
77
99
78
100
### Post-Merge checklist
79
101
-[ ] You have tagged the release using `git tag v<version_number>`_(for the contributor merging the PR)_.
80
102
-[ ] You have pushed this tag using `git push <tag_name>`_(for the contributor merging the PR)_.
81
103
-[ ] You have deleted the branch.
82
104
83
105
### Pre-Release checklist
84
-
-[ ] Everything in the Pre-Merge checklist is completed. (Except the last two if this is a release candidate).
106
+
-[ ] Everything in the Pre-Merge checklist is completed.
85
107
-[ ]`git remote show origin` shows you are in the correct repository.
86
108
-[ ]`git branch` shows that you are on the expected branch.
87
109
-[ ]`git status` shows that there are no unexpected changes.
88
-
-[ ]`dash/version.py` is at the correct version.
110
+
-[ ]Both `package.json` and `dash_cytoscape/package.json` versions have been correctly updated.
89
111
90
112
### Release Step
91
-
-`python setup.py sdist` to build.
92
-
-`twine upload dist/<the_version_you_just_built>` to upload to PyPi.
113
+
Complete the "Publishing" section.
93
114
94
115
### Post-Release checklist
116
+
-[ ] Step 1 and 2 of Post-merge checklist are completed.
95
117
-[ ] You have closed all issues that this pull request solves, and commented the new version number users should install.
96
118
-[ ] If significant enough, you have created an issue about documenting the new feature or change and you have added it to the [Documentation] project.
97
119
-[ ] You have created a pull request in [Dash Docs] with the new release of your feature by editing that project's [`requirements.txt` file](https://github.com/plotly/dash-docs/blob/master/requirements.txt) and you have assigned `@chriddyp` to review.
98
120
99
121
## Financial Contributions
100
122
101
-
Dash, and many of Plotly's open source products, have been funded through direct sponsorship by companies. [Get in touch] about funding feature additions, consulting, or custom app development.
123
+
Dash, and many of Plotly's open source products, have been funded through direct sponsorship by companies. [Get in touch](https://plot.ly/products/on-premise/) about funding feature additions, consulting, or custom app development.
View the [Dash Cytoscape User Guide](https://dash.plot.ly/cytoscape/) to get started now. You can also use the [component reference](https://dash.plot.ly/cytoscape/reference/) to find how to use a certain feature.
62
+
63
+
To learn more about the core Dash components and how to use callbacks, view the [Dash documentation](https://dash.plot.ly/).
64
+
65
+
For supplementary information about the underlying Javascript API, view the [Cytoscape.js documentation](http://js.cytoscape.org/).
66
+
58
67
## Development
59
68
60
69
Please follow the following steps for local testing:
@@ -90,13 +99,6 @@ $ python setup.py install
90
99
```
91
100
92
101
93
-
## Documentation
94
-
95
-
For using Dash and for a Python-specific overview of Dash Cytoscape, view the [Dash User Guide](https://dash.plot.ly/). It's chock-full of examples, pro tips, and guiding principles.
96
-
97
-
For supplementary information about the underlying javascript API, view the [Cytoscape.js documentation](http://js.cytoscape.org/).
98
-
99
-
100
102
101
103
## Notes
102
104
@@ -115,3 +117,6 @@ See https://plot.ly/dash/support for ways to get in touch.
115
117
## Acknowledgments
116
118
117
119
Huge thanks to the Cytoscape Consortium and the Cytoscape.js team for their contribution in making such a complete API for creating interactive networks. This library would not have been possible without their massive work!
120
+
121
+
The Pull Request and Issue Templates were inspired from the
0 commit comments