Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (45 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 2.03 KB

Contributing to Net Commander

First off, I would like to thank you so much for considering the extension helpful and contributing to net‑commander! 🎉 Your help makes this project better for everyone.

Table of Contents

  1. Reporting Issues
  2. Suggesting Enhancements
  3. Your First Code Contribution
  4. Development Setup
  5. Coding Style & Tests
  6. Commit Messages
  7. Pull Request Process
  8. Updating Documentation & Changelog
  9. Code of Conduct

Reporting Issues

If you find a bug or unexpected behavior:

  1. Check existing Issues to see if it’s already been reported.
  2. If not, open a new issue and include:
    • A clear and descriptive title.
    • Steps to reproduce.
    • What you expected vs. what happened.
    • Operating system and Node version (node -v).
    • Any relevant screenshots or logs.

Please use the bug report template when prompted.

Suggesting Enhancements

Got an idea for a new feature or improvement?

  1. Search existing issues to avoid duplicates.
  2. Open a new issue with:
    • A descriptive title (e.g. “Add dark‑mode theme support”).
    • A summary of the feature.
    • Any design ideas or mockups.
    • Why it would be useful.

Please use the feature request template when prompted.

Your First Code Contribution

Unsure where to start? Look for issues labeled:

These are typically simpler tasks ideal for first‑time contributors.

Development Setup

  1. Fork the repo and clone your fork locally: 
    git clone https://github.com/<your‑username>/net‑commander.git
cd net‑commander