Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

09 04 add ellipsis code review instructions #136

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions ellipsis.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 1.3

about:
- This is a codebase for Deepscatter, a webGL based plotting library.

pr_review:
confidence_threshold: 0.7
rules:
- "Code should be DRY (Don't Repeat Yourself)"
- 'Apache Arrow is the data format of choice, and avoid early loading of Arrow data is a primary goal'
- 'Avoid memory leaks'
- 'Use D3 modules for scales, axes, and other data visualization fundamentals'
- 'Extremely Complicated Code Needs Comments'
- 'Use Descriptive Variable and Constant Names'
- 'Follow the Single Responsibility Principle'
- 'The public API has some underscores in it that must remain, but new code should use camelCase.'
- 'This library should be high performance; operations that operate over all the data in a dataframe should generally aim to execute in under 30ms,and things that block the main thread are bad.'