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.

Sign up for GitHub

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

Jump to bottom

Naming case convention for charts #46

Open

amercier opened this issue Sep 19, 2013 · 0 comments

amercier commented Sep 19, 2013

In http://misoproject.com/d3-chart/charts.html there is only one rule about chart naming convention:

Please name your chart in the format: d3.chart.*, for example d3.chart.barchart etc.

(1) This doesn't tell which case style should be used for naming charts. For instance, if I want to create a "horizontal bar chart", it could be:

not separated : d3.chart.horizontalbar
hyphen-separated : d3.chart.horizontal-bar
underscore-separated : d3.chart.horizontal-bar
camel-cased : d3.chart.horizontalBar

(my favorite: hyphen-separated)

(2) This doesn't tell whether it should include the word "chart" or not:

with: d3.chart.horizontal-bar
without: d3.chart.horizontal-bar-chart

(my favorite: without)

I think that stating about these two question would enforce uniformity between charts and therefore add quality to this project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment