Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

83 lines (62 loc) · 2.35 KB

Contributing to KCL Modules

Thank you for your interest in contributing to our KCL Modules! This document provides guidelines and instructions for contributing.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in our Issues
  2. If not, create a new issue using the bug report template
  3. Include as much detail as possible:
    • Which module you're using
    • What you expected to happen
    • What actually happened
    • Steps to reproduce
    • Code examples

Suggesting Enhancements

  1. Check if the enhancement has already been suggested in our Issues
  2. If not, create a new issue using the feature request template
  3. Describe your use case and why this enhancement would be useful

Pull Requests

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Add or update tests as needed
  5. Update documentation if needed
  6. Submit a pull request using our pull request template

Development Setup

  1. Install KCL
  2. Clone the repository
  3. Install dependencies: 
    nix develop

Adding a New Module

  1. Create a new directory for your module: 
    mkdir <module_name>
cd <module_name>
kcl mod init
    Note: Choose a descriptive name for your module using snake_case format (e.g., string_utils, http_client).
  2. Implement your module with the following structure:
    • Source code files (.k extension)
    • Test files (with _test.k suffix)
    • README.md with comprehensive documentation
    • kcl.mod file for module configuration
  3. Add your module to the main project:
    • Update the top-level README.md to include your module
    • Ensure all documentation is clear and complete

Testing

  • Write tests for any new functionality
  • Run tests using: 
    kcl test ./...

Documentation

  • Keep READMEs up to date
  • Document all public functions and types
  • Include examples in documentation
  • Update the changelog when making changes

Questions?

Feel free to create an issue for any questions about contributing.

Thank you for contributing to KCL Modules!