Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
399 changes: 355 additions & 44 deletions .github/workflows/ci.yml

Large diffs are not rendered by default.

34 changes: 34 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- id: check-merge-conflict
- id: check-toml
- id: debug-statements

- repo: local
hooks:
- id: cargo-fmt
name: cargo fmt
entry: cargo fmt --all --
language: system
types: [rust]
pass_filenames: false

- id: cargo-clippy
name: cargo clippy
entry: cargo clippy --all --tests --all-features -- -D warnings
language: system
types: [rust]
pass_filenames: false

- id: cargo-test
name: cargo test
entry: cargo test
language: system
types: [rust]
pass_filenames: false
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<!-- changelog-insert-here -->

## [0.1.0-pre+beta.15] - Initial Release

### Added
- Initial implementation of doublets library
- Memory-efficient doublets storage
- Support for split and unit storage modes
- FFI bindings for cross-language support
- Comprehensive data structures for link management
310 changes: 310 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,310 @@
# Contributing to doublets-rs

Thank you for your interest in contributing! This document provides guidelines and instructions for contributing to this project.

## Development Setup

1. **Fork and clone the repository**

```bash
git clone https://github.com/YOUR-USERNAME/doublets-rs.git
cd doublets-rs
git submodule update --init --recursive
```

2. **Install Rust**

Install Rust using rustup (if not already installed):

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

The project uses a specific nightly toolchain configured in `rust-toolchain.toml`:
```toml
[toolchain]
channel = "nightly-2022-08-22"
```

3. **Install development tools**

```bash
rustup component add rustfmt clippy
```

4. **Install pre-commit hooks** (optional but recommended)

```bash
pip install pre-commit
pre-commit install
```

5. **Build the project**

```bash
cargo build
```

## Development Workflow

1. **Create a feature branch**

```bash
git checkout -b feature/my-feature
```

2. **Make your changes**

- Write code following the project's style guidelines
- Add tests for any new functionality
- Update documentation as needed

3. **Run quality checks**

```bash
# Format code
cargo fmt

# Run Clippy lints
cargo clippy --all --tests --all-features

# Check file sizes
node scripts/check-file-size.mjs

# Run all checks together
cargo fmt --check && cargo clippy --all --tests --all-features && node scripts/check-file-size.mjs
```

4. **Run tests**

```bash
# Run all tests
cargo test

# Run tests with verbose output
cargo test --verbose

# Run doc tests
cargo test --doc

# Run a specific test
cargo test test_name
```

5. **Add a changelog fragment**

For any user-facing changes, create a changelog fragment:

```bash
# Create a new file in changelog.d/
# Format: YYYYMMDD_HHMMSS_description.md
touch changelog.d/$(date +%Y%m%d_%H%M%S)_my_change.md
```

Edit the file to document your changes:

```markdown
### Added
- Description of new feature

### Fixed
- Description of bug fix
```

**Why fragments?** This prevents merge conflicts in CHANGELOG.md when multiple PRs are open simultaneously.

6. **Commit your changes**

```bash
git add .
git commit -m "feat: add new feature"
```

Pre-commit hooks will automatically run and check your code.

7. **Push and create a Pull Request**

```bash
git push origin feature/my-feature
```

Then create a Pull Request on GitHub.

## Code Style Guidelines

This project uses:

- **rustfmt** for code formatting
- **Clippy** for linting with pedantic and nursery lints enabled
- **cargo test** for testing

### Code Standards

- Follow Rust idioms and best practices
- Use documentation comments (`///`) for all public APIs
- Write tests for all new functionality
- Keep functions focused and reasonably sized
- Keep files under 1000 lines
- Use meaningful variable and function names

### Documentation Format

Use Rust documentation comments:

```rust
/// Brief description of the function.
///
/// Longer description if needed.
///
/// # Arguments
///
/// * `arg1` - Description of arg1
/// * `arg2` - Description of arg2
///
/// # Returns
///
/// Description of return value
///
/// # Errors
///
/// Description of when errors are returned
///
/// # Examples
///
/// ```
/// use doublets::example_function;
/// let result = example_function(1, 2);
/// assert_eq!(result, 3);
/// ```
pub fn example_function(arg1: i32, arg2: i32) -> i32 {
arg1 + arg2
}
```

## Testing Guidelines

- Write tests for all new features
- Maintain or improve test coverage
- Use descriptive test names
- Organize tests in modules when appropriate
- Use `#[cfg(test)]` for test-only code

Example test structure:

```rust
#[cfg(test)]
mod tests {
use super::*;

mod my_feature_tests {
use super::*;

#[test]
fn test_basic_functionality() {
assert_eq!(my_function(), expected_result);
}

#[test]
fn test_edge_case() {
assert_eq!(my_function(edge_case_input), expected_result);
}
}
}
```

## Pull Request Process

1. Ensure all tests pass locally
2. Update documentation if needed
3. Add a changelog fragment (see step 5 in Development Workflow)
4. Ensure the PR description clearly describes the changes
5. Link any related issues in the PR description
6. Wait for CI checks to pass
7. Address any review feedback

## Changelog Management

This project uses a fragment-based changelog system similar to [Scriv](https://scriv.readthedocs.io/) (Python) and [Changesets](https://github.com/changesets/changesets) (JavaScript).

### Creating a Fragment

```bash
# Create a new fragment with timestamp
touch changelog.d/$(date +%Y%m%d_%H%M%S)_description.md
```

### Fragment Categories

Use these categories in your fragments:

- **Added**: New features
- **Changed**: Changes to existing functionality
- **Deprecated**: Features that will be removed in future
- **Removed**: Features that were removed
- **Fixed**: Bug fixes
- **Security**: Security-related changes

### During Release

Fragments are automatically collected into CHANGELOG.md during the release process. The release workflow:

1. Collects all fragments
2. Updates CHANGELOG.md with the new version entry
3. Removes processed fragment files
4. Bumps the version in Cargo.toml
5. Creates a git tag and GitHub release

## Project Structure

```
.
├── .github/workflows/ # GitHub Actions CI/CD
├── changelog.d/ # Changelog fragments
│ └── README.md # Fragment instructions
├── ci/ # CI scripts
├── dev-deps/ # Development dependencies (git submodules)
├── doublets/ # Main doublets library
│ ├── src/ # Source code
│ ├── tests/ # Integration tests
│ └── benches/ # Benchmarks
├── doublets-decorators/ # Decorator patterns (in rework)
├── doublets-ffi/ # FFI bindings
├── integration/ # Integration tests
├── scripts/ # Utility scripts
├── .gitignore # Git ignore patterns
├── .pre-commit-config.yaml # Pre-commit hooks
├── Cargo.toml # Workspace configuration
├── CHANGELOG.md # Project changelog
├── CONTRIBUTING.md # This file
├── LICENSE # Unlicense (public domain)
├── README.md # Project README
└── rust-toolchain.toml # Rust toolchain configuration
```

## Release Process

This project uses semantic versioning (MAJOR.MINOR.PATCH):

- **MAJOR**: Breaking changes
- **MINOR**: New features (backward compatible)
- **PATCH**: Bug fixes (backward compatible)

Releases are managed through GitHub releases. To trigger a release:

1. Manually trigger the release workflow with a version bump type
2. Or: Update the version in Cargo.toml and push to main

## Getting Help

- Open an issue for bugs or feature requests
- Use discussions for questions and general help
- Check existing issues and PRs before creating new ones

## Code of Conduct

- Be respectful and inclusive
- Provide constructive feedback
- Focus on what is best for the community
- Show empathy towards other community members

Thank you for contributing!
20 changes: 20 additions & 0 deletions changelog.d/20251228_030839_ai_driven_pipeline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
bump: minor
---

### Added
- Configured `rust-toolchain.toml` with nightly-2022-08-22 for reproducible builds
- Added comprehensive CONTRIBUTING.md with development guidelines
- Added changelog fragment system with `changelog.d/` directory for conflict-free versioning
- Added utility scripts for version management and release automation
- Added `.pre-commit-config.yaml` for code quality hooks
- Added code coverage reporting with cargo-llvm-cov and Codecov integration
- Added extensive test coverage for data module (Link, Doublet, Error, Handler/Fuse)
- Added comprehensive tests for traits module (Doublets, DoubletsExt, Links)
- Added tests for memory module components (LinksHeader, stores)

### Changed
- Improved CI/CD workflow with template best practices
- Added concurrency control to prevent duplicate CI runs
- Added automatic release workflow based on changelog fragments
- Added manual release dispatch option for maintainers
Loading
Loading