Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

Commit 81580c7

Browse files
Create developeronboarding
1 parent 3ac2a19 commit 81580c7

1 file changed

Lines changed: 76 additions & 0 deletions

File tree

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Developer Onboarding – Specify Software
2+
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.
3+
4+
### ✅ Required Reading
5+
6+
Before writing a single line of code, carefully read and understand the following documentation:
7+
8+
Development Process
9+
- 📖 (Specify Processes)[https://specify.github.io/dev_process/specify_processes.html]
10+
Developer Expectations
11+
- 📖 (Developer Expectations)[https://specify.github.io/dev_process/dev_expectations.html]
12+
13+
### 💬 Discourse Forum Participation
14+
15+
- Go to (Specify Discourse Forum)[https://discourse.specifysoftware.org]
16+
- Follow the available tutorial
17+
- Review existing posts and follow any relevant categories
18+
- Use the forum tools directly in the app as you learn
19+
20+
### 📚 Explore the Documentation Portal
21+
22+
Spend time reviewing (Specify.io)[https://specify.github.io] to understand the types of resources available. Focus areas include:
23+
- GUIDELINES
24+
- INTERNAL PROCESSES
25+
- TESTING
26+
- SPECIFY SOFTWARE
27+
- DEVELOPER UTILS
28+
29+
### 🧠 Local Installation
30+
31+
You are expected to install and run the following locally:
32+
- Docker Desktop
33+
- DBeaver
34+
- Specify 7 (SP7)
35+
- Specify 6 (SP6)
36+
- Specify Wizard
37+
Instructions can be found on https://specify.github.io, or on Discourse, or on GitHub.
38+
39+
### 🐞 Backend Debugger Setup
40+
41+
Follow this guide to set up the backend debugger in VS Code:
42+
- 📖 (Setup backend debugger)[https://specify.github.io/developer_utils/setting_up_backend_debugger.html]
43+
Make sure it is working correctly—this is essential for debugging and testing backend changes.
44+
45+
### 🔑 Test Panel Access
46+
47+
To work with the test panel:
48+
- Follow the steps outlined in the (debugger setup guide)[https://specify.github.io/server_management/specify_ssh_docker_guide.html]
49+
- Contact the relevant team members to generate the necessary API keys and credentials
50+
- Create a new instance and test it
51+
- Download a database
52+
- Upload a database
53+
- Make yourself aware of the naming conventions we use
54+
55+
### 🧪 User Testing Requirement
56+
57+
For your first two weeks, dedicate 3 hours per day to using the Specify application as a user. The goal is to:
58+
- Learn user workflows
59+
- Understand common pain points
60+
- Explore different modules and features hands-on
61+
62+
➡️ 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.
63+
64+
### 🔍 Testing Tasks
65+
66+
You will also gain familiarity with our testing practices by:
67+
68+
- 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.
69+
- Going through the general testing checklist at the end of the second week for an item or row selected by your manager.
70+
71+
### 🗓️ Daily Check-Ins
72+
73+
You are expected to meet daily with your manager to:
74+
- Review tasks for the following day
75+
- Share feedback on how your current day went
76+
- Ask any questions or raise blockers early

0 commit comments

Comments
 (0)