New developer#
Welcome to the New developer onboarding
Use this as your roadmap — start here, then move through the phases below. This page guides you through everything you need to know as a new SKAO developer.
Learn more about the SKAO projectQuick start: first 5 steps#
Recommended actions to get you up and running.
Set up accounts
Create your GitLab account and request access to SKAO repositories
Join Slack channels
Connect with the team on #proj-onboarding and your team channel
Set up GitLab account
Configure SSH keys and clone your first repository
Read Code of Conduct
Understand our community standards and expectations
Download onboarding checklist
Get a printable checklist to track your progress
How to contribute to SKAO#
Follow these guidelines to contribute to SKAO projects.
Start with the code of conduct#
Read the SKAO Code of Conduct before contributing. This sets expectations for all SKAO interactions.
Understand the workflow#
Follow these steps to contribute:
Check repository-specific policies: Each repository may have unique contribution requirements
Clone or fork the repository: Get the code locally
Create a feature branch: Follow our Branching policy
Make your changes: Write code and tests
Open a Merge Request: Repository maintainers will review your contribution
Tip
Read the Working with GitLab guide to understand our workflow.
Follow coding standards#
Adhere to the Coding guidelines for your programming language.
Most repositories run automated checks:
Python: PEP-8 linting
Other languages: Check the repository’s CI/CD pipeline for specific standards
Write clear documentation#
Tools we use:
Sphinx for documentation generation
reStructuredText for markup
ReadTheDocs for hosting
File naming conventions:
Use hyphens:
environment-setup.rstAvoid underscores:
environment_setup.rst
Heading structure:
Follow Thomas Cokelaer’s heading syntax for consistency.
Write in active voice#
Use “you” to address readers:
✅ “Configure your environment with these steps”
❌ “The environment must be configured”
Use singular “they” for gender-neutral references:
✅ “If a developer needs help, they must contact the System Team”
❌ “If a developer needs help, he/she must contact the System Team”
Ensure accessibility#
Images must have:
Adequate contrast (test by viewing in black and white)
Alt-text for screen readers
Add alt-text to all images unless the information appears in a figure caption.
Read the guide to writing good alt-text for best practices.
Contribute to this portal#
Found an issue with this documentation? See Contribute to the developer portal.
Onboarding roadmap#
Your journey from Day 1 to becoming a contributing team member.