Contributing

Setup

Clone the repository and install dependencies:

git clone https://github.com/dawidurbanski/universal-data-layer.git
cd universal-data-layer
npm install

Project Structure

universal-data-layer/
├── packages/
│   ├── core/                     # Core UDL functionality
│   ├── plugin-source-contentful/ # Contentful plugin
│   └── codegen-typed-queries/    # TypedDocumentNode generation
├── examples/
│   └── nextjs/                   # Next.js example app
└── docs/                         # Documentation site (Nuxt/Docus)

Development

Building Packages

npm run build

Running Tests

npm test

Running the Example

# Start UDL server with mock data
cd examples/nextjs
npm run udl:dev

# In another terminal, start Next.js
npm run dev

Contributing Guidelines

1. Fork the repository
2. Create a feature branch: git checkout -b feature/my-feature
3. Make your changes
4. Add tests for new functionality
5. Run tests: npm test
6. Commit with a descriptive message
7. Submit a pull request

Code Style

• TypeScript for all new code
• ESLint and Prettier for formatting
• Comprehensive JSDoc comments

Run linting:

npm run lint

Reporting Issues

Found a bug or have a feature request? Open an issue on GitHub.

Next Steps

• Creating Plugins - Build your own plugin
• Configuration Reference - Full config options