Contributing Guide

Contributing to danfojs

Table of contents:

TL;DR
Where to start?
Project Structure
Development Setup
Working with Git
Documentation Guidelines
Making Changes
Creating Pull Requests

TL;DR

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

Quick setup for experienced contributors:

git clone https://github.com/javascriptdata/danfojs.git
cd danfojs
yarn install
yarn build
yarn test

Where to start?

For first-time contributors:

Look for issues labeled "good first issue"
Read through our Documentation

Project Structure

The project is organized into three main packages:

danfojs-base: Core functionality shared between browser and Node.js versions
danfojs-browser: Browser-specific implementation
danfojs-node: Node.js-specific implementation

Most new features should be added to danfojs-base unless they are environment-specific.

Development Setup

Prerequisites

Node.js (v16.x or later)
Yarn package manager
Git

Installation

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/YOUR_USERNAME/danfojs.git
cd danfojs

Install dependencies:
```
yarn install
```

Building

Build all packages:

yarn build

Build specific package:

cd src/danfojs-browser
yarn build

Watch mode for development:

yarn dev

Testing

Run all tests:

yarn test

Run specific test file:

yarn test tests/core/frame.test.js

Run tests matching a pattern:

yarn test -g "DataFrame.add"

Run tests in watch mode:

yarn test --watch

Working with Git

Create a new branch:

git checkout -b feature/your-feature-name

Make your changes and commit:
```
git add .
git commit -m "feat: add new feature"
```
We follow Conventional Commits for commit messages:
- feat: for new features
- fix: for bug fixes
- docs: for documentation changes
- test: for adding tests
- refactor: for code refactoring

Push to your fork:

git push origin feature/your-feature-name

Documentation Guidelines

Good documentation includes:

JSDoc comments for all public methods
Clear parameter descriptions
Return value documentation
Usage examples

Example:

/**
 * Add two series of the same length
 * @param {Series} series1 - First series to add
 * @param {Series} series2 - Second series to add
 * @returns {Series} New series containing the sum
 * 
 * @example
 * const s1 = new Series([1, 2, 3])
 * const s2 = new Series([4, 5, 6])
 * const result = add_series(s1, s2)
 * // result: Series([5, 7, 9])
 */
function add_series(series1, series2) {
    // Implementation
}

For methods with multiple options, use an options object:

/**
 * Join two or more dataframes
 * @param {Object} options - Join options
 * @param {DataFrame[]} options.df_list - Array of DataFrames to join
 * @param {number} options.axis - Join axis (0: index, 1: columns)
 * @param {string} options.by_column - Column to join on
 * @returns {DataFrame} Joined DataFrame
 */
function join_df(options) {
    // Implementation
}

Making Changes

Write tests for new functionality
Ensure all tests pass
Update documentation if needed
Add an entry to CHANGELOG.md
Run linter: yarn lint

Creating Pull Requests

Push your changes to your fork
Go to the danfojs repository
Click "Pull Request"
Fill out the PR template:
- Clear description of changes
- Link to related issue
- Screenshots/examples if relevant
- Checklist of completed items

Your PR will be reviewed by maintainers. Address any feedback and update your PR accordingly.

Need Help?

Check our Documentation
Ask in GitHub Issues

Thank you for contributing to danfojs! 🎉

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!