Contributor Guide

You want to contribute to the Lino source code? That's great! Thanks in advance!

This part of the developer guide is for core developers and for contributing developers.

Get started

• Setting up a Lino contributor environment
  • Run getlino to clone Lino repositories
• Setting up your work environment
  • What is a project?
  • Navigating between projects
  • Some more shell aliases
  • Configuring atelier
  • Usage examples
  • Have LibreOffice server running on your machine
  • Quickly installing the Lino SDK into a new virtualenv
  • How to switch to the development version of Atelier
  • Where to store repositories
• Moving from GitHub to GitLab
  • How to update the remote setting of your clone
  • How to move a repo from GitHub to GitLab
  • Why avoid GitHub?

Sharing code with others

• Legal considerations for contributors
  • Contributor License Agreement
  • Coding standards
  • Standard files
• How to submit a pull request
  • Send a patch
  • Using GitHub
  • Using git request-pull
  • Pushing directly to master branch?
• Working with others
  • Contributing code
  • Send a patch
  • Submit a pull request
  • Continuous integration
  • About demo projects
  • What means inv ?

Testing

• Testing Lino applications
  • Django tests in demo projects
  • Doctests in Lino
  • Migration tests
  • Cypress
  • Travis CI
• The manual testing suite for the Lino framework
  • Multiple addresses

Writing documentation

• Writing documentation
  • Types of documentation
  • Start your own developer blog
  • Building the Lino docs
  • Getting started with Sphinx
  • Doctests in Lino
  • Where to put your docstrings
  • Help Texts
  • About developer documentation
  • Shared Sphinx resources
  • Documenting changes
  • Redirected historic URLs
  • Shared documentation pages
  • About local help pages

Internationalization

• How to contribute translations
• Lino in Bengali

Deployment

• The deployment process
  • Running the Lino test suite
  • Date-based versioning
  • Simulating a release on PyPI
  • Publishing to PyPI

Drafts

• Coding style
• Debugging generated ExtJS Javascript code
• Repairing data

Internals

• How Lino applications use setup.py

Other

• Testing pages
• Git cheat sheet
• About logging in a development environment
• Responsive design
• Diamond inheritance
• About analysis
• About django-admin commands
• Screenshot tours
• Social Authentication
• What is an application?
• Introduction to Combo boxes
• Chooser examples
• Demo fixtures

Simulate a production site

• Setting up a simulated production server
• Simulate a HTTPS server on your development machine

Thanks to

• Thanks to