Thank you for your interest in contributing to Tidal Hi-Fi! This document outlines the guidelines and best practices for contributing to this project.
- Node.js (use the version specified in
.nvmrcif available) - nvm (recommended for Node.js version management)
- npm (comes with Node.js)
- Fork and clone the repository
- Install Node.js using nvm (if available):
nvm use - Install dependencies:
npm install - Start the file watcher:
npm run watchornpm run dev* - Run
npm startwhenever you want to test your changes.
- This only watches for
typescriptchanges, not html or sass.
This project uses specific tools that you should familiarize yourself with:
- npm: Package management and script running
- nvm: Node.js version management
- oxlint: Code linting
- oxfmt: Code formatting
- TypeScript: Primary development language
- Electron: Desktop application framework
Please use these tools as they're configured in the project rather than introducing alternatives.
- Target the develop branch: All pull requests should target the
developbranch, notmaster. Themasterbranch is reserved for stable releases. - Keep PRs focused: Limit each pull request to one specific change or feature. This makes reviews easier and reduces the chance of conflicts.
- Separate boyscouting: Keep refactoring, renaming, and cleanup work in separate PRs from feature additions or bug fixes.
- Clear descriptions: Provide a clear description of what your PR does and why it's needed.
- Reference issues: Link to relevant issues using
Fixes #123orCloses #123. - Don't update version files: You don't need to update the changelog, version numbers, or package.json version. The maintainers will handle this during the release process when features/fixes are bundled together.
- Discuss first: If you want to introduce something new (features, dependencies, architectural changes), it's best to discuss it first in Issues or Discussions.
- Check existing work: Look through existing issues and PRs to avoid duplicating effort.
- Small changes first: Consider starting with small bug fixes or documentation improvements to get familiar with the codebase.
- Follow the existing code style and patterns
- Use oxlint for linting and oxfmt for formatting:
npm run lintandnpm run format - Write TypeScript with proper type definitions
- Add appropriate comments for complex logic, but please don't comment on every flow/line
- Follow existing naming conventions
- AI assistance is allowed for development, but you are fully responsible for:
- The quality of code you submit
- Understanding how your code works
- Responding to feedback and questions about your implementation
- Ensuring the code follows project standards and patterns
- Write clear, descriptive commit messages
- Try to use conventional commit format when possible (e.g.,
feat:,fix:,docs:,refactor:) - Keep commits atomic (one logical change per commit)
- Test your changes thoroughly before submitting
- Ensure the application builds successfully on at least 1 platform to not waste GH resources:
npm run build - Run linting:
npm run lint - Verify formatting:
npm run format - Test the application functionality manually
Please use our GitHub issue templates:
- Report a Bug: Use this template to report bugs or issues
- Request a Feature: Use this template to suggest new features or enhancements
Before creating a new issue, please search existing issues to avoid duplicates.
- All submissions require review before merging
- Reviews may request changes or improvements
- Maintain a positive and collaborative attitude
- Understand that your code might not be merged.
- Project Documentation
- Issues
- Discussions
- Electron Documentation
- TypeScript Documentation
- Known issues
By contributing to this project, you agree that your contributions will be licensed under the same license as the project. See LICENSE for details.
This project follows a standard code of conduct. Please be respectful, inclusive, and professional in all interactions.
If you have questions about contributing, feel free to:
- Open a Discussion
- Ask in an existing Issue
- Reach out to the maintainers
Thank you for contributing to Tidal Hi-Fi! 🎵