Open Source Guidelines

Candidates
  • the considered project should be of some relevance, no reinvention of the wheel
  • the considered project should not harm Valtech's reputation
Distributables & Sources
  • source code must be always included in the available releases or as a seperate source distributable
  • the project is licensend under [VPL], Apache 2.0 or GPL. and is to be included in the releases and/or in the source code
  • Releases should include a readme file with change & installation notes
  • Software with failing tests must not be delivered
  • distributables should be installable and usable with litte amount of work by the end-user
  • distributables always have a unique version
Technical requirements for projects
  • a build process should always allow to build distributables (and optional source distributables) out of the project
  • the project should always include a sufficient amount of test cases, as a rule this should be automated tests. Test execution is included in the build process.
  • source code should include a sufficient amount of API documentation
  • known anti-patterns should be avoided
Project Documentation
  • the project should be well documented, it should be easy for new users be able to learn how the distributables can be installed, configured and used
  • in addition source.valtech.com should provide a relevant Wiki homepage, project summary, etc.
Presentation
  • should be nice if the project can be used as a show case, e.g. includes some presentations
  • should be nice if the functionality/usage of the project is explained by applying it to a sample application
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.