Getting Started

Welcome! Here's how to get started contributing to Find a Doc, Japan.

Step 1: Join the Community

Join our Slack workspace and say hello in #general or #dev-team. Let us know you're interested in helping out and we'll get you pointed in the right direction.

Step 2: Set Up Your Environment

Follow the Running the Code guide to get the project running locally.

Recommended IDE plugins (for VS Code):

• ESLint — automatic linting visibility
• Vue Official — Vue 3 / Nuxt support
• Tailwind CSS IntelliSense — Tailwind class autocomplete

Step 3: Create a Branch and Code

1. Clone the repo you want to work on and create a branch from main — prefix with your username: yourusername/my-change
2. Write your code and make sure all automated checks and linters pass
3. Push your branch and submit a Pull Request on GitHub with a clear description of what you did and how to test it

Step 4: Code Review

Work with the team to review and merge your PR. Ask for help in #dev-team on Slack if you need it.

New to Open Source?

Check out our Beginner Resources for guides on Git, GitHub, and making your first Pull Request.