Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (45 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 2.89 KB

Contributing to Teams for Linux

Thank you for considering contributing! This guide will help you get started with development.

Tip

New to Electron? This project is a great starting point for learning!

Note

This is a quick reference guide. For comprehensive developer documentation including architecture, code standards, testing strategy, and detailed guidelines, see the Full Contributing Guide.

Quick Start

  1. Fork the repository
  2. Clone your fork and create a feature branch
  3. Make changes (entry point: app/index.js)
  4. Test your changes with npm start
  5. Submit a pull request to main branch

Each app/ subfolder contains a README explaining its purpose.

Testing Pull Requests

You can test PR changes without building from source by downloading pre-built artifacts from GitHub Actions.

How to Download PR Artifacts

  1. Navigate to the PR on GitHub
  2. Click the "Checks" tab at the top of the PR
  3. Select a completed workflow run (look for green checkmarks)
  4. Scroll down to "Artifacts" section at the bottom of the workflow page
  5. Download the artifact for your platform (available for Linux, macOS, and Windows)

Note: You need to be logged into GitHub to download artifacts. Artifacts are retained for 30 days.

See the full guide for more details.

Development Setup

Prerequisites: Node.js and npm (installation guide)

# Clone and setup
git clone https://github.com/your-username/teams-for-linux.git
cd teams-for-linux
npm install

# Run from source
npm start

# Lint code (required before commits)
npm run lint

# Run E2E tests
npm run test:e2e

For detailed setup, building, testing, and code standards, see the Full Contributing Guide.

Additional Resources