Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (57 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

78 lines (57 loc) · 2.33 KB

Contributing to Koii Desktop Node

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

Code of Conduct

Please read and follow our Code of Conduct in all your interactions with the project.

Development Workflow

  1. Fork the Repository

    • Fork the repository to your GitHub account
    • Clone your fork locally

  2. Create a Feature Branch

    • Create a new branch for your feature/fix
    • Use descriptive branch names (e.g., feature/add-login, fix/button-styling)

  3. Make Your Changes

    • Follow the coding standards (see below)
    • Write tests for new functionality
    • Update documentation as needed

  4. Commit Your Changes

    • Write clear, descriptive commit messages
    • Reference issues in your commits (e.g., fix: resolve #123)

  5. Push and Create a Pull Request

    • Push your changes to your fork
    • Create a pull request to the main repository
    • Fill out the pull request template

Coding Standards

TypeScript/JavaScript

  • Use TypeScript for all new code
  • Follow the existing ESLint configuration
  • Use meaningful variable and function names
  • Add appropriate type annotations
  • Document complex functions with JSDoc comments

React Components

  • Use functional components with hooks
  • Follow the existing component structure
  • Use proper prop types
  • Implement error boundaries where appropriate

Styling

  • Use Tailwind CSS for styling
  • Follow the existing design system
  • Ensure responsive design
  • Maintain consistent spacing and typography

Testing

  • Write tests for new features
  • Maintain existing test coverage
  • Use Jest and React Testing Library
  • Include both unit and integration tests

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the CHANGELOG.md with a summary of changes
  3. Ensure all tests pass
  4. Request review from at least one maintainer

Getting Help

If you need help or have questions:

Security

If you discover any security-related issues, please email security@koii.network instead of using the issue tracker.

Thank you for contributing to Koii Desktop Node!