[ckan-dev] Pull request: coding standards

Mon Nov 19 11:08:04 UTC 2012

On 19 November 2012 10:23, Sean Hammond <sean.hammond at okfn.org> wrote:

> Hey, I've tidied and updated the coding standards a little and added a
> couple of bits. I did it all in separate commits so you can see what
> happened (although git diffs for these rst files seem to be horrible).
> Pull request here:
>
> https://github.com/okfn/ckan/pull/173
>
>
> http://docs.ckan.org/en/3020-bug-update-coding-standards/#for-ckan-developers
>
> If this gets merged I'd like to add a link in the README on the github
> front page, so they're more prominent.
>
> Some notes on the state of these coding standards:
>
> Getting really long so look for anything that could be removed.
>
> I think the How to Contribute section and the Coding Standards sections
> are probably pretty complete (well the Python Coding Standards anyway, I
> didn't look at the Javascript, HTML or CSS).
>
> I've had a quick scan added a couple of minor comments re css

I think it would be good to include some other issues in here such as
translation.  Although there is a section it is about creating the
translations not how to ensure that templates are translated (more of an
issue with jinja2) but also translations in python/javascript.  Maybe that
would be covered elsewhere.

Looking at the docs in general I think we may need to review some more, eg
for the 2.0 template changes (themeing) as the docs seem to be genshi based
or not cover much in the templates.  To be honest I think that quite a lot
of work is needed to improve the documentation for 2.0

Good start on the coding standards -

Toby

> The Code Architecture section is missing all sorts of important stuff
> that would be good to have in there to document where we're trying to go
> with this thing. I've tried to avoid the temptation to put in stuff
> that's better learned by reading the code (or by adding docstrings to
> the code) such as describing the structure of CKAN (e.g. saying what
> each package is for). Instead I'm trying to go for a list of tips about
> the right ways to do things in CKAN, e.g.  always go through
> logic.action not model, always go through get_action(), etc.
>
> The Release Cycle section is probably woefully out of date and
> incomplete. Maybe it should be renamed Release Process and the stuff
> from the Release Process wiki page copied into it. I didn't touch it.
>
> _______________________________________________
> ckan-dev mailing list
> ckan-dev at lists.okfn.org
> http://lists.okfn.org/mailman/listinfo/ckan-dev
> Unsubscribe: http://lists.okfn.org/mailman/options/ckan-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/ckan-dev/attachments/20121119/4cde066b/attachment-0001.html>