CONTRIBUTING.md

🤝 Contributing to דאטאבוס

Welcome 👋 and thank you for considering contributing to דאטאבוס, a project by Hasadna!
We’re excited to have you on board.

🧭 Where to Start

• Browse open issues
• Start easy: look for the “Good First Issue” label
• Want impact? Choose from our milestones

🙋 Have feedback or spotted something unclear? Open an issue.

🛠️ IDE Configuration

• Enable - "Format on Save"
• Set Default Formatter - "Prettier"
• Install Plugins
  • ESLint – Linting for JavaScript/TypeScript
  • Prettier – Code formatting
  • Stylelint – Linting for CSS/SCSS

⚡ Running the Project

You can run the project:

• 🖥️ Locally (recommended for repeat contributors)
• 🌐 In Gitpod (ready-to-code environment in your browser) → Open in Gitpod

Local Setup

1. Do NOT fork – instead, request write access (so previews & CI run correctly).
2. Clone:

git clone https://github.com/hasadna/open-bus-map-search.git
cd open-bus-map-search

3. Install dependencies:

npm install

4. Run locally:

npm start

Open http://localhost:3000.

📌 Pull Requests

1. Create a branch (name it after the issue/feature, e.g., feat/add-close-button)
2. Commit with a conventional message
3. Push & open a PR → tag a maintainer as reviewer
4. Ensure it runs locally before submitting

🔗 PR tutorial for beginners

📝 Commit Message Conventions

Type	Usage Example
feat	feat: add modal component
fix	fix: make close button visible on mobile
docs	docs: update README with new info
refactor	refactor: split App into subcomponents
chore	chore: upgrade React to v18
test	test: add integration tests
style	style: remove empty line

🧪 Testing

Command	Description
npm run test	Run Jest + Playwright tests (excluding visual tests)
npm run test:unit	Run Jest unit tests
npm run test:unit:ci	Run Jest with coverage
npm run test:e2e	Run Playwright end-to-end tests
npm run test:e2e:ui	Run Playwright tests with interactive UI
npm run test:e2e:visual	Run visual regression tests with (Playwright + Applitools )
npm run test:storybook	Run Storybook visual tests with (Applitools)

More: Playwright CLI

📚 Resources

• 🎨 Figma design file
• 🗄️ Data model schema
• 📖 API docs (Swagger)
• 🌍 Deployed website

📺 Tutorials:

• Dashboard & Maps walkthrough
• Bug reporting guide

🆘 Troubleshooting

We’re here to help! Join our Slack.

❓ FAQ

Why is my commit marked ❌ red?

• 🧹 Lint error → run npm run lint:fix
• 🧪 Test error → run npm run test:unit:ci
• 🏗️ Build error → run npm run build
• 📝 Invalid PR title → use conventional commit style (feat: …, fix: …)