Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (57 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

80 lines (57 loc) · 1.42 KB
Raw

Contributing to Net Control by K4HEF

Thank you for your interest in contributing to this project!

Development Setup

Prerequisites

  • Node.js 18 or higher
  • Docker and Docker Compose
  • Git

Local Development

  1. Fork the repository
  2. Clone your fork
  3. Create a feature branch
  4. Make your changes
  5. Test thoroughly
  6. Submit a pull request

Code Style

  • Use consistent indentation (2 spaces)
  • Follow existing code patterns
  • Add comments for complex logic
  • Keep functions focused and small

Backend Development

cd backend
npm install
npm run dev

Frontend Development

cd frontend
npm install
npm run dev

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Ensure all tests pass
  3. Update the version number following SemVer
  4. The PR will be merged once reviewed

Bug Reports

When filing a bug report, please include:

  • Description of the issue
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable
  • Environment details

Feature Requests

We welcome feature requests! Please provide:

  • Clear description of the feature
  • Use case / why it's needed
  • Any implementation ideas

Code of Conduct

  • Be respectful and professional
  • Focus on constructive feedback
  • Help others in the community
  • Follow amateur radio best practices

Questions?

Feel free to open an issue for questions or discussion.

73 de K4HEF