Contributing to RocketPy

Contents:

• Running RocketPy as a Developer
  • Opening rocketpy folder
  • Preparing directory for code editing
  • Running a simulation with RocketPy
  • Further considerations
• GitHub Workflow for RocketPy Hackathon 2022
  • Git and GitHub Introduction
  • Git Installation
  • GitHub Account Configuration
  • Repository Workflow
  • Forks and Branches
  • Issues and Challenges
  • Further Information
• Style Guide
  • Code Style
  • Documentation Style
  • Git Style
• RocketPy with Docker
  • Benefits
  • Requirements
  • Build the image
  • Run the container
  • Run the unit tests
  • Compose docker images
  • Changing to other operational systems
• Building the Documentation
  • How to build the documentation in your local machine
  • How to integrate the documentation with ReadTheDocs

This section is still a work in progress. Here you will find information on how to contribute to our code base.