49 lines (38 loc) · 1.11 KB

Contributing to OpenLake Hub

Welcome to the OpenLake Hub project! We appreciate your interest in contributing.

Getting Started

Fork the repository on GitHub.
Clone your fork locally.
Install dependencies:
```
npm install
```
Set up environment: Copy .env.example to .env and adjust if necessary.
```
cp .env.example .env
```

Development

Run locally:
```
npm run start:dev
```
Run tests:
```
npm run test
```
Linting:
```
npm run lint
```

Code Style

We use Prettier and ESLint. Please ensure your code format matches the project standards.
Follow the existing directory structure: src/<module>/....
Use NestJS idioms (Dependency Injection, Decorators, Modules).

Pull Requests

Create a new branch for your feature or fix.
Commit your changes with clear messages.
Push to your fork and submit a Pull Request.
Ensure CI passes.

License

By contributing, you agree that your code will be licensed under the MIT License.