Contributing

Adding New Surveys

Adding a new LSMS survey requires no Python programming -- just YAML configuration files that map the survey's variables to the standardized interface. See CONTRIBUTING.org for the full walkthrough.

Brief overview:

1. Create directory structure: Country/Year/Documentation and Country/Year/Data
2. Add source data using DVC
3. Create data_scheme.yml (country-level) declaring available tables
4. Create data_info.yml (per-wave) mapping survey variables to standard names
5. Submit a pull request

Building the Documentation

The docs use MkDocs with the Material theme and mkdocstrings for API reference generation.

# Install doc dependencies
pip install mkdocs-material mkdocstrings[python]

# Live preview
mkdocs serve

# Build static site
mkdocs build

Running Tests

pytest tests/

Contact

• GitHub Issues: Report bugs or request features at the repository
• Email: Contact ligon@berkeley.edu to discuss contributions