Changes between Version 9 and Version 10 of SoftwareDevelopment/ProjectGuidelines


Ignore:
Timestamp:
10/11/16 10:32:30 (8 years ago)
Author:
Twan Goosen
Comment:

highlighted words

Legend:

Unmodified
Added
Removed
Modified

  • SoftwareDevelopment/ProjectGuidelines

    v9 v10  
    1010* Provide good quality '''in-code documentation'''. Follow the conventions associated with the language, framework or platform that you are using (e.g. use [http://www.oracle.com/technetwork/articles/java/index-137868.html Javadoc] for Java rather than just inline comments).
    1111* If applicable, '''document your API''', especially if its public facing. There are tools that make this easy, such as [http://swagger.io/ Swagger] (for Java)
    12 * Bundle some basic documentation with your sources 'and' distribution packages. Include at least the following:
     12* '''Bundle''' some basic documentation with your sources 'and' distribution packages. Include at least the following:
    1313 * `README` (brief project description, preferably with pointers to more detailed information)
    1414  * If required, include build instructions (ideally these should be very short or even redundant)
    … …  
    4343 * Make sure that all '''dependencies''' are available, either via public repositories or via additional repositories defined in your build descriptor.
    4444* Test your build regularly, ideally on a daily basis or with every commit/push, i.e. attempt to implement '''continuous integration'''. Generally applicable tools that can be used for this are, among others, [https://travis-ci.org Travis] and [https://jenkins.io/ Jenkins].
    45 * Consider distributing your application as a [https://docker.com/ Docker] image. The Docker website has [https://docs.docker.com/engine/getstarted/step_four/ instructions and more information].
     45* Consider distributing your application as a '''[https://docker.com/ Docker] image'''. The Docker website has [https://docs.docker.com/engine/getstarted/step_four/ instructions and more information].
    4646* Make '''all sources available''' that are needed to build your software. Use the [https://trac.clarin.eu CLARIN SVN] or !GitHub (you can join [https://github.com/clarin-eric CLARIN's organisation].
    4747