Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (51 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

70 lines (51 loc) · 1.7 KB
Raw

Contributing to Harbor

Thank you for your interest in contributing to Harbor! We appreciate your help in making this project better.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new feature branch: git checkout -b feature/your-feature-name
  4. Install dependencies: npm install
  5. Make your changes
  6. Test your changes: npm test and npm run build
  7. Commit your changes with clear messages
  8. Push to your fork
  9. Open a Pull Request

Development Setup

# Install dependencies
npm install

# Build the extension
npm run build

# Watch for changes during development
npm run watch

# Load the extension in Chrome:
# 1. Go to chrome://extensions/
# 2. Enable "Developer mode"
# 3. Click "Load unpacked"
# 4. Select the dist/ directory

Coding Guidelines

  • Use TypeScript for type safety
  • Follow the existing code style
  • Keep components focused and single-responsibility
  • Write meaningful commit messages
  • Add comments for complex logic
  • Test your changes before submitting

Pull Request Process

  1. Update relevant documentation
  2. Add tests for new features
  3. Ensure all tests pass
  4. Follow the PR template provided
  5. Be responsive to code review feedback
  6. Keep PRs focused on a single feature or fix

Reporting Issues

  • Use the GitHub issue tracker
  • Provide a clear description
  • Include steps to reproduce (for bugs)
  • Include your environment details
  • Add relevant labels

Code of Conduct

Please note that this project is governed by our Code of Conduct. By participating, you are expected to uphold this code.

Questions?

Feel free to open an issue for any questions or discussions about contributing.

Thank you for contributing to Harbor!