Skip to contents

<div class=“callout-box”> Welcome to the climasus4r community! — This project is built through the collective effort of researchers, developers, and data enthusiasts. Every contribution, no matter the size, is valuable and welcome. This guide was created to help you find the best way to participate. </div>

Why Contribute?

Contributing to an open-source project like climasus4r is an opportunity to:

  • Develop Skills: Improve your skills in R, Python, data analysis, software development, and scientific communication.
  • Build Your Portfolio: GitHub contributions are a distinctive expertise for your academic or professional career.
  • Network: Connect with a network of experts in climate, health, and data science.
  • Create Impact: Help build a tool that strengthens health surveillance and supports public policies in Brazil.

<div class=“callout callout-tip”> Code of Conduct: All interactions in our project follow a Code of Conduct. We are committed to maintaining a welcoming, respectful, and collaborative environment for everyone. </div>


Roles to Play

Our team is organized into several levels of engagement, from technical leadership to occasional contributions. Each role within the workflow has specific responsibilities, but all are essential to the success of the climasus4r project.

<div class=“pathway-box” style=“line-height: 2;”> <strong style=“display: block; margin-bottom: 8px;”>🚀 Contribution Profile:</strong> <span class=“badge”>Contributor</span> • <span class=“badge”>Documentation & Support</span> • <span class=“badge”>Research Assistant</span> • <span class=“badge”>Assistant Developer</span> • <span class=“badge”>Senior Developer</span> • <span class=“badge”>Software Engineer</span> • <span class=“badge”>Scientific Consultant</span> • <span class=“badge”>Coordinator</span> </div>


🎯 Leadership Core

Coordinator & Lead Developer

<div class=“role-card”> <span class=“badge badge-core”>LEADERSHIP</span>

Responsibilities:

  • Define the strategic vision and technical roadmap of the project
  • Architect the overall structure of the package and APIs
  • Coordinate releases and semantic versioning
  • Review and approve critical Pull Requests
  • Manage relationships with partner institutions
  • Mentor senior and scientific developers

Requirements: Advanced experience in R/Python package development, open-source project management, and technical leadership. Mastery of Git, CI/CD, and agile methodologies.

How to become one: This role is assigned by the current project maintainer based on consistent contributions, demonstrated strategic vision, and long-term commitment.

</div>


💻 Technical Team

Senior R/Python Developer

<div class=“role-card”> <span class=“badge badge-tech”>ADVANCED TECHNICAL</span>

Responsibilities • Develop complex features and core modules
• Implement performance and scalability optimizations
• Create robust automated tests (testthat, pytest)
• Review junior developers’ code
• Document technical architecture and internal APIs
Tech Stack Advanced R (data.table, terra, sf, tidymodels), Python (pandas, xarray, rasterio), Advanced Git, CI/CD (GitHub Actions), Docker
Requirements • 3+ years of experience with R or Python
• Experience with geoprocessing and spatial analysis
• Knowledge of package development (devtools, setuptools)
• Technical mentoring capability
How to Contribute 1. Look for Issues tagged with complex or architecture
2. Propose performance improvements in existing functions
3. Participate in technical decisions in Discussions
4. Submit PRs with comprehensive tests and technical documentation

</div>

Software Engineer

<div class=“role-card”> <span class=“badge badge-tech”>INFRASTRUCTURE</span>

Responsibilities • Maintain CI/CD and automation infrastructure
• Manage containers and development environments
• Implement data pipelines and ETL
• Ensure code quality (linting, formatting)
• Optimize integration with external systems (APIs, databases)
Tech Stack GitHub Actions, Docker, Linux, SQL/NoSQL, REST APIs, Cloud (AWS/GCP), Python/R for automation
Requirements • Experience in DevOps and automation
• Knowledge of software engineering best practices
• Familiarity with scientific computing environments
• Ability to document technical processes
How to Contribute 1. Improve our GitHub Actions workflows
2. Create Dockerfiles for reproducible environments
3. Implement data validation pipelines
4. Optimize continuous integration and automatic deployment

</div>

Assistant R/Python Developer

<div class=“role-card”> <span class=“badge badge-tech”>JUNIOR TECHNICAL</span>

Responsibilities • Implement helper functions and utilities
• Fix medium-complexity bugs
• Write unit tests
• Refactor code for better readability
• Create examples and vignettes
Tech Stack Intermediate R (tidyverse, basic sf), Intermediate Python, Basic Git, RMarkdown/Quarto
Requirements • 1+ year of experience with R or Python
• Knowledge of data analysis
• Willingness to learn package development
• Openness to receive constructive feedback
How to Start 1. Look for Issues with good first issue or help wanted labels
2. Fork the repository and create named branches (feature/short-description)
3. Participate in the mentoring program with senior developers
4. Complete refactoring and documentation tasks

</div>


🔬 Scientific Team

Scientific Consultant

<div class=“role-card”> <span class=“badge badge-science”>SCIENTIFIC VALIDATION</span>

Responsibilities • Audit the statistical and epidemiological validity of methods
• Validate the interpretation of climate and health indicators
• Review implemented statistical models
• Suggest new relevant analyses and metrics
• Co-author publications and technical reports
Areas of Expertise Epidemiology, Climatology, Public Health, Statistics, Biometeorology, Environmental Health
Requirements • Advanced degree (Master’s/PhD) in a related field
• Experience with quantitative health data analysis
• Knowledge of climate research methodologies
• Interest in open science and reproducibility
How to Participate 1. Send an email to climasus4r.dev@example.com with the subject “Scientific Consulting”
2. Attach your CV and a description of your expertise
3. Participate in monthly scientific validation meetings
4. Review Pull Requests that affect statistical methods

</div>

Research Assistant (Undergrad, Master’s, PhD, Post-Doc)

<div class=“role-card”> <span class=“badge badge-science”>APPLIED RESEARCH</span>

Responsibilities • Apply the package in academic research projects
• Develop case studies with real SUS data
• Validate features in real research scenarios
• Report bugs and suggest use-case based improvements
• Produce educational material and tutorials
Opportunities • Scientific Initiation with scholarship
• Data for dissertation/thesis
• Co-authorship in scientific papers
• Networking with senior researchers
Requirements • Affiliation with a research institution
• Project related to climate and health
• Willingness to document package usage
• Commitment to open science
How to Participate 1. Describe your research project in a Discussion
2. Indicate how climasus4r integrates into your research
3. Share preliminary results and feedback
4. Collaborate in creating vignettes based on your use case

</div>


🌟 Community & Support

Documentation & Support

<div class=“role-card”> <span class=“badge badge-community”>COMMUNICATION</span>

Responsibilities • Maintain up-to-date technical documentation (pkgdown, Quarto)
• Create tutorials, guides, and educational materials
• Answer questions in Issues and Discussions
• Translate documentation (PT/EN/ES)
• Manage the website and social media presence
Skills Technical communication, RMarkdown/Quarto, Git/GitHub, Educational material design, Academic social networks
Requirements • Excellent technical writing skills
• Basic R knowledge (to test examples)
• Empathy to help beginner users
• Creativity for scientific communication
How to Contribute 1. Improve the documentation of existing functions
2. Create video tutorials or blog posts
3. Answer new users’ questions
4. Translate content to other languages
5. Propose improvements to the site’s UX and documentation

</div>

Project Contributor

<div class=“role-card”> <span class=“badge badge-community”>COLLABORATOR</span>

Activities • Report bugs and suggest features via Issues
• Test new versions and provide feedback
• Share use cases and applications
• Promote the package at events and on social media
• Minor fixes (typos, broken links)
Profile Data enthusiasts, students, health professionals, early-career researchers — everyone is welcome!
Requirements • GitHub account
• Interest in climate and health data
• Desire to participate in the community
First Steps 1. ⭐ Star the repository to track updates
2. 📖 Read the documentation and try the examples
3. 🐛 Found a problem? Open an Issue!
4. 💡 Have an idea? Start a Discussion
5. 🗣️ Tell colleagues about the project

</div>


How to Choose Your Profile

<div class=“callout-box”> <strong>Still don’t know where to start?</strong>

Answer these quick questions:

<ul> <li><strong>I want to write code and have experience:</strong> → Senior Developer or Software Engineer</li> <li><strong>I want to write code but I’m learning:</strong> → Assistant Developer</li> <li><strong>I am a researcher and want to use the package:</strong> → Research Assistant</li> <li><strong>I am a methods expert:</strong> → Scientific Consultant</li> <li><strong>I like to write and help people:</strong> → Documentation & Support</li> <li><strong>I want to help without a fixed commitment:</strong> → Project Contributor</li> </ul> </div>


Onboarding Process

  1. Read the Code of Conduct — All roles require mutual respect
  2. Explore the Repository — Familiarize yourself with the structure and existing documentation
  3. Introduce Yourself — In the Discussions tab, introduce yourself and mention your interest
  4. Start Small — Choose a simple task for your first contact
  5. Grow Gradually — As you gain confidence, take on greater responsibilities

<div class=“callout callout-tip”> <strong>Recognition:</strong>
All contributors are listed on the climasus4r website. Significant contributions are acknowledged in releases and scientific publications. </div>

Ready to start? 🚀
Visit github.com/ByMaxAnjos/climasus4r and join the community!