|
| 1 | +# Code Review Checklist |
| 2 | + |
| 3 | +## Code quality & design |
| 4 | + |
| 5 | +- 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? |
| 6 | + |
| 7 | + A few suggestions: |
| 8 | + |
| 9 | + - Make your variable names descriptive and use the same naming conventions throughout the code. |
| 10 | + |
| 11 | + - For more complex pieces of logic, consider putting a comment, and maybe an example. |
| 12 | + |
| 13 | + - 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. |
| 14 | + |
| 15 | + - 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. |
| 16 | + |
| 17 | +* 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. |
| 18 | +* 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. |
| 19 | + |
| 20 | +## Component API |
| 21 | + |
| 22 | +- Have you tested your component on the Python side by creating an app in `usage.py` ? |
| 23 | + |
| 24 | + Do all of your component's props work when set from the back-end? |
| 25 | + |
| 26 | + Should all of them be settable from the back-end or are some only relevant to user interactions in the front-end? |
| 27 | + |
| 28 | +- Have you provided some basic documentation about your component? The Dash community uses [react docstrings](https://github.com/plotly/dash-docs/blob/master/tutorial/plugins.py#L45) to provide basic information about dash components. Take a look at this [Checklist component example](https://github.com/plotly/dash-core-components/blob/master/src/components/Checklist.react.js) and others from the dash-core-components repository. |
| 29 | + |
| 30 | + At a minimum, you should describe what your component does, and describe its props and the features they enable. |
| 31 | + |
| 32 | + Be careful to use the correct formatting for your docstrings for them to be properly recognized. |
| 33 | + |
| 34 | +## Tests |
| 35 | + |
| 36 | +- The Dash team uses integration tests extensively, and we highly encourage you to write tests for the main functionality of your component. In the `tests` folder of the boilerplate, you can see a sample integration test. By launching it, you will run a sample Dash app in a browser. You can run the test with: |
| 37 | + ``` |
| 38 | + python -m tests.test_render |
| 39 | + ``` |
| 40 | + [Browse the Dash component code on GitHub for more examples of testing.](https://github.com/plotly/dash-core-components) |
| 41 | +
|
| 42 | +## Ready to publish? Final scan |
| 43 | +
|
| 44 | +- Take a last look at the external resources that your component is using. Are all the external resources used [referenced in `MANIFEST.in`](https://github.com/plotly/dash-docs/blob/0b2fd8f892db720a7f3dc1c404b4cff464b5f8d4/tutorial/plugins.py#L55)? |
| 45 | +
|
| 46 | +- You're ready to publish! Continue to [step #9 here](README.md#publishing). |
0 commit comments