Contributing to the Project • orbweaver

Thank you for considering contributing to this project! Your contributions help improve the project for everyone. Please follow these guidelines to ensure a smooth collaboration.

✨ Commit Message Guidelines

This project follows the Conventional Commits specification. Please use the following format when making commits:

type(scope): description

Examples: - feat(api): add new endpoint for fetching user data - fix(parser): correct error handling in XML parsing - docs(readme): update installation instructions

Common commit types: - feat: A new feature - fix: A bug fix - docs: Documentation changes - style: Code style changes (formatting, missing semi-colons, etc.) - refactor: Code refactoring without changing functionality - test: Adding or updating tests - chore: Maintenance tasks (e.g., dependency updates)

🔨 Running Tasks

This project uses a task runner defined in Taskfile.yml. Below are the key tasks you might need to run during development.

Cleaning Build Artifacts

task clean

Running Tests

Run all tests:

task test

Run Rust-specific tests:

task test-rust

Run R-specific tests:

task test-r

Generating Documentation

task document

Installing the Project

task install

Checking the Package

task check

🛠️ Submitting a Contribution

Fork the repository.
Create a new branch with a descriptive name:
```
git checkout -b feature/new-feature
```
Make changes and commit using Conventional Commits.
Push the changes to your fork:
```
git push origin feature/new-feature
```
Create a Pull Request on GitHub.

✅ Review Process

All PRs must pass the automated tests before merging.
At least one project maintainer must approve the changes.

Thank you for your contribution! 🚀