OpenAtlas is developed with some standards in mind.
Only open source libraries (e.g. jQuery) and open source software requirements (e.g. a PostgreSQL database) are used.
All non-code files (e.g. logo) should be open too (CC BY-SA 4.0).
This guaranties that the application can be shared as open source (GPL 2) e.g. on GitHub.
If 3rd party software or media is used it is important to:
- Check the license for compatibility
- Store them in openatlas/static/vendor
- Add a license file if available
We are using PEP 8 Style Guide for Python Code with the exception that we are allowing for a line length of 100 characters.
Python code should be covered by tests, preferable with assertions.
We are using HTML 5 and the site should be validating correctly.
Exceptions may be acceptable if (harmless) non valid HTML 5 is produced by 3rd party libraries.