Skip to content

Contributors Guide

Jump to bottom
Jasmine Daly edited this page Nov 22, 2024 · 6 revisions

Contributor Guide for the CRAN Cookbook 🧑‍🍳

We greatly appreciate your contribution and interest in improving the CRAN Cookbook! To ensure your recipe is added in a timely manner, we have a few guidelines that support community discussion and formatting standards.

Where to Start 📍

If you have previous experience maintaining an R package on CRAN, your insights on navigating the complexities of both R CMD check and CRAN Volunteer checks could be incredibly valuable. The common challenges you’ve encountered are likely shared by current and new maintainers alike, making them great candidates for new Cookbook recipes.

To contribute a new recipe, please follow each step in this guide to increase the likelihood of publication.

Acceptance Pathway ✅

  1. Post a Discussion Topic
    Begin by posting your topic in the Community Contributions forum.

    • We also encourage you to share your ideas and code with the wider R development community for additional review and vetting. The [email protected] mailing list is a great place to engage with other contributors and experienced R developers who can provide valuable feedback.

  2. Start a Branch and Make Suggestions
    After discussing and/or receiving upvotes on your topic, fork the repo and create a new branch for your contribution.

    • Carefully select the appropriate Cookbook chapter that aligns with your recipe, whether it’s related to specific components of an R package or general issues/best practices.
    • Follow the recipe template outlined below ⬇️ to structure your content consistently.
    • Don't forget to add your name as a bullet point (if you desire) to the Contributors section in the preface.qmd chapter

  3. Submit a Pull Request (PR)
    Once your recipe is prepared, submit a PR for review.

  4. Merge and Clean Up
    After your PR is approved by a reviewer, please merge it yourself and delete your development branch.

  5. Cookbook Rendering
    Once merged, a GitHub Action will automatically trigger to render the updated Cookbook.

Thank you for sharing your expertise to help us create a resource that benefits the entire R community!

Recipe Template 🍴

# [Concise title]

## Problem

[A brief 1-2 sentence description]

## Solution

[A brief 1-2 sentence description]

### Details

[A detailed explanation 2+ sentence description including if necessary a code block section of the correct implementation and or the incorrect implementation which make make issue discovery easier for new package maintainers]

[It may also be enriching to include a [callout block](https://quarto.org/docs/authoring/callouts.html) in this section too]


------------------------------------------------------------------------

Style Guide (In-progress)

  1. Tone
  2. Tense
    1. Past vs Present
  3. Title Case
  4. Selecting Ideal Code or Text Examples
  5. Creative Inspiration Tips
Clone this wiki locally