Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (76 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

107 lines (76 loc) · 2.79 KB

Contributing to JourNULL‑CodeXCaliber‑25

Thank you for helping make this project better! Whether you’re fixing bugs, proposing new features, improving documentation, or just giving feedback, your contributions are welcome and appreciated.

Table of Contents

  1. Getting Started
  2. Development Workflow
  3. Local Setup
  4. Submitting Changes
  5. Reporting Issues
  6. Code of Conduct
  7. Additional Resources

Getting Started

  1. Fork this repository on GitHub
  2. Clone your fork locally
  3. Create a branch for your work: 
    git checkout -b feature/your-feature-name
  4. Make your changes in small, focused commits
  5. Push your branch to your fork
  6. Open a Pull Request against main in the upstream repo

Development Workflow

  • Use clear, descriptive branch names:
    • feature/login-form
    • fix/navbar-overlap
  • Scope each branch to a single issue or feature
  • Adhere to the project’s existing code style and formatting
  • Run any existing tests and add new ones if appropriate

Local Setup

Prerequisites

  • pnpm (preferred package manager)
  • Bun (runtime for backend)
  • Node.js version 16 or higher

Installation & Run

# 1. Clone your fork
git clone https://github.com/<your-username>/JourNULL-CodeXCaliber-25.git
cd JourNULL-CodeXCaliber-25

# 2. Install dependencies using pnpm
pnpm install

# 3. Start the development server
pnpm start

# 4. For backend, ensure Bun is installed and run using:
bun dev

Submitting Changes

  1. Push your branch to GitHub.
  2. Open a Pull Request against main.
  3. In your PR description:
    • Reference the related issue (e.g., “Closes #13”)
    • Summarize your changes in bullet points
    • Include any relevant screenshots or testing steps
  4. Wait for review and address feedback as needed.

Reporting Issues

When opening an issue, please include:

  • A concise title and clear description
  • Steps to reproduce the problem
  • Expected vs. actual behavior
  • Screenshots, logs, or error messages if applicable

Code of Conduct

This project is governed by the Contributor Covenant v2.1.
By participating, you agree to abide by its terms.
Please read the full text in CODE_OF_CONDUCT.md.

Additional Resources