Skip to content

docs: add CONTRIBUTING.md #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jsit wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: add CONTRIBUTING.md #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to the WMBR App

This document contains the most important patterns and practices we follow.

## General Guidelines

- Aliases have been set up for imports; rather than importing from relative
paths (`../../../utils/Colors`), use the alias defined in `tsconfig.json`.
- Use color tokens from `src/utils/Colors.ts`. Do not hard-code hex values. If a needed token is missing, discuss with the team before adding a new one.

## Code style & linting

- Install the ESLint and EditorConfig extensions/plugins in your IDE/editor.
- Fix lint failures locally with `npx eslint . --fix` and run the test suite before opening a PR.

## Testing

### Quick Testing Rules

- Check existing test files for common patterns.
- Use `userEvent` for interactions, and prefer `await screen.findBy*()` for async/network-driven elements.
- Query preference: getByRole → getByLabelText → getByText → getByTestId.

### Mocks

- Don't mock anything in `src/services` (ScheduleService, RecentlyPlayedService, TrackPlayerService, etc.). These services should run in tests to exercise parsing and business logic.
- Certain global mocks are defined in `jest.setup.ts`.
- To add deterministic network responses for playlists/schedules, add entries to `__mocks__/MockNetworkResponses.ts` and update the fetch mock in `jest.setup.ts`.
- Use helpers in `src/utils/TestUtils.ts` (e.g. `generateScheduleXml`, `generatePlaylistResponse`) to produce realistic mock data.

### Running tests

- For local development run the whole suite: `npm test`.
- To watch all files while making changes, use: `npm test -- --watchAll` or `npm
test -- --watch Component` to focus on a specific component.

## Committing and PRs

- In commit messages and PR titles, try to adhere to [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
Examples:
- `fix: correct show title parsing in ScheduleService`
- `feat: add dark mode support to About screen`
- `chore: update dependencies and fix lint issues`
- `docs: improve CONTRIBUTING.md with testing guidelines`