Developer Onboarding β Specify Softwareο
Welcome to the Specify development team! This onboarding guide is designed to help you get up to speed with our tools, processes, and expectations. Please follow each step carefully and reach out to your manager if you have any questions.
β Required Readingο
Before writing a single line of code, carefully read and understand the following documentation:
Development Process
π Specify Processes Developer Expectations
π¬ Discourse Forum Participationο
Go to Specify Discourse Forum
Follow the available tutorial
Review existing posts and follow any relevant categories
Use the forum tools directly in the app as you learn
π Explore the Documentation Portalο
Spend time reviewing Specify.io to understand the types of resources available. Focus areas include:
GUIDELINES
INTERNAL PROCESSES
TESTING
SPECIFY SOFTWARE
DEVELOPER UTILS
π§ Local Installationο
You are expected to install and run the following locally:
Docker Desktop
DBeaver
Specify 7 (SP7)
Specify 6 (SP6)
Specify Wizard Instructions can be found on https://specify.github.io, or on Discourse, or on GitHub.
π Backend Debugger Setupο
Follow this guide to set up the backend debugger in VS Code:
π Setup backend debugger Make sure it is working correctlyβthis is essential for debugging and testing backend changes.
π Test Panel Accessο
To work with the test panel:
Follow the steps outlined in the debugger setup guide
Contact the relevant team members to generate the necessary API keys and credentials
Create a new instance and test it
Download a database
Upload a database
Make yourself aware of the naming conventions we use
π§ͺ User Testing Requirementο
For your first two weeks, dedicate 3 hours per day to using the Specify application as a user. The goal is to:
Learn user workflows
Understand common pain points
Explore different modules and features hands-on
β‘οΈ Important: For each tool or component you explore, write down any questions or uncertainties you encounter. These will be discussed during your daily manager meeting. Your manager will either answer them directly or direct you to the appropriate team member.
π Testing Tasksο
You will also gain familiarity with our testing practices by:
Reviewing and testing 4β5 pull requests (PRs) assigned by your manager. These PRs will include testing instructions to help you understand how features are validated.
Going through the general testing checklist at the end of the second week for an item or row selected by your manager.
ποΈ Daily Check-Insο
You are expected to meet daily with your manager to:
Review tasks for the following day
Share feedback on how your current day went
Ask any questions or raise blockers early