Fri 1 Apr 2016

Add advice for developers section

Igor Nadj Public Seen by 388

This is a long document that risks not being read by the people who should read it most, developers. I suggest adding a short section at the top of the document.

Suggested content:

Advice for Developers

Open sourcing your code is a great idea, it helps contribute back to the community, as well as improves your own codebase from contributions from the community. Additionally it lets you become part of the wider open source ecosystem which helps share modern ideas and tools to develop some really cool stuff. Many government agencies are already on board. You should aim to have your code open source by default.

Open sourcing your code involves creating a repository on a public platform like Github or Bitbucket. The most important thing to add to your repository is a README file with an overview of what your code does, and your License (see section 13).


Cam Findlay Mon 4 Apr 2016

So your advocating for a kind of TLDR; section?

See https://www.loomio.org/d/TfnmWEr5/alternative-version-control-repositories we are proposing not to include specific repo technologies and locations (since you mention some in your proposed wording).


Roy Storey Mon 4 Apr 2016

I would like to suggest that "Best Practice" documents would capture this advice and ways of working behaviours.


Cam Findlay Thu 6 Oct 2016

We are close to having a first draft of some open source technical guidance for govt opens source projects to accompany NZGOAL-SE, still a few sections to pad out however you are welcome to head over and take a look through. We'd welcome any feedback and you can comment directly on the document.

See this thread for more details: https://www.loomio.org/d/Sq2oF6iE/guidance-notes-open-source-software-development-practices-and-technical-considerations