Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
148 lines (118 loc) · 5.57 KB

CONTRIBUTING.md

File metadata and controls

148 lines (118 loc) · 5.57 KB

Contribution Guidelines for Joor

Thank you for your interest in contributing to Joor! This document outlines the process and standards for contributing, ensuring a smooth collaboration experience.

Table of Contents

Code of Conduct

Please follow the guidelines in our CODE_OF_CONDUCT.md located in the pro branch. This document ensures a friendly, respectful, and productive environment for all contributors.

Reporting Security Vulnerabilities

For any security issues, please refer to our SECURITY.md file which provides detailed instructions on how to report vulnerabilities responsibly.

Style Guide

Contributors must adhere to the guidelines defined in STYLEGUIDE.md. This document covers:

  • Code formatting
  • Writing uniform code styles
  • Commit message conventions
  • Pull request and discussion etiquette

Setup & Development Workflow

To ensure consistency across development environments, please follow these steps:

  1. Environment Setup

    • Ensure you have Node.js version 22.13.0 or any LTS version above 18 installed.

  2. Cloning and Setup

    • Fork the repository on GitHub.
    • Clone your fork to your local machine: 
      git clone https://github.com/<your-username>/joor.git
    • Navigate to the repository's directory and run: 
      npm run setup

  3. Building the Project

    • Execute the build process: 
      npm run build
    • This command will create a release folder. Navigate into it and run: 
      cd release
npm run link

  4. Linking Joor for Testing

    • Go to the desired playground folder: 
      cd dev/playground/ground*  # Choose your preferred ground
npm link joor
    • Note: If you install any packages via npm, the linkage may break. You will need to re-link using the above steps.

  5. Testing and Linting

    • Run tests using: 
      npm run test
    • For lint checks and auto-fixing: 
      npm run lint
npm run lint:fix
    • For code formatting: 
      npm run format

Folder Structure

joor/
├── dev/                        # Development-related files
│   ├── playgrounds/            # Testing areas for Joor
│   └── scripts/                # Development scripts (build, setup, etc.)
├── src/                        # Source code
│   ├── core/                   # Core functionalities
│   │   ├── functionality1/
│   │   └── functionality2/
│   ├── data/                   # Data files (docs links, HTTP codes, etc.)
│   ├── helpers/                # Utility helper code
│   ├── middlewares/            # Middleware functions
│   │   └── cors.ts             # Example: CORS middleware
│   ├── packages/               # Reusable packages
│   │   ├── package1/
│   │   └── package2/
│   ├── types/                  # TypeScript type definitions
│   └── index.ts                # Main entry point; exports all methods, functions, types, etc.
├── tests/                      # Tests
│   ├── integration/            # Integration tests
│   └── unit/                   # Unit tests

Branching and Pull Request Process

To maintain a clear and consistent workflow:

  1. Fork the repository from GitHub.
  2. Clone your fork locally.
  3. Create a new branch following the naming pattern: 
    username-bug-fix-(issue-number)
    Alternatively, for new features: 
    username-new-feature-(short-description)
  4. Commit your changes following guidelines in the STYLEGUIDE.md.
  5. Open a pull request (PR) describing your changes with sufficient context and reference any related issues. Note: you must create PR to staging branch.

Additional Resources

  • Project's main documentation: Refer to README.md for the full introduction and setup instructions.
  • Code of Conduct: Enforced via CODE_OF_CONDUCT.md in the pro branch.
  • Security Policies: See SECURITY.md for detailed information on reporting vulnerabilities.

Online Documentation

Discord Community

For discussion or any help, join our Discord server here: https://discord.gg/eepjRJJD6c