Contributing

The repo2docker community is welcoming of all kinds of help and participation from others. Below are a few ways that you can get involved, as well as resources for understanding the structure and design of the repo2docker package.

• Contributing to repo2docker
  • Types of contribution
  • Process for making a contribution
  • Guidelines to getting a Pull Request merged
  • Setting up for Local Development
    • Clone the repository
    • Set up a local virtual environment
    • Code formatting
    • Verify that docker is installed and running
  • Building the documentation locally
• Roadmap
  • Using the roadmap
    • Sharing Feedback on the Roadmap
    • What do we mean by “next step”?
    • Reviewing and Updating the Roadmap
  • The roadmap proper
    • Project vision
    • Now
    • Soon
    • Later
• Architecture
  • Buildpacks
    • Detect
    • Build base environment
    • Copy repository contents
    • Assemble repository environment
    • Push
    • Run
  • ContentProviders
• Design of repo2docker
  • Deterministic output
  • Reproducibility and version stability
  • Unix principles “do one thing well”
  • Composability
  • Pareto principle (The 80-20 Rule)
• Common tasks
  • Running tests
    • Troubleshooting Tests
  • Update and Freeze BuildPack Dependencies
    • Conda dependencies
    • Make a Pull Request
  • Creating a Release
    • Create a new tag and push it
    • Create a new release on the GitHub repository
  • Keeping the Pipfile and requirements files up to date
• Uncommon tasks
  • Compare generated Dockerfiles between repo2docker versions
• Add a new buildpack
  • Criteria to balance and consider
    • Adding libraries or UI to existing buildpacks
• Add a new content provider

The Reproducible Execution Environment Specification Contributing to repo2docker