Documentation

This part of the documentation describes how to contribute to icalendar’s documentation.

For quick or small edits through the GitHub web interface, read the chapter Make small edits via GitHub.

For larger edits, the chapter Build and check documentation provides a comprehensive command reference to build and check the quality of documentation.

Refer to the chapter Style guide when you need examples of language, terminology, code, or markup.

Find issues

icalendar’s documentation may have errors and omissions. Open issues are available to work on. Contributions to improve the documentation are welcome. This is a good way for first-time contributors to participate in the icalendar community.

Find open issues to work on by clicking either button below.

Documentation

Good First Issue

Contents

• Make small edits via GitHub
• Build and check documentation
  • Prerequisites
  • File locations
  • Make commands
  • Add features
  • Pull request previews
  • Continuous integration checks
• Style guide
  • Voice and tone
  • Specific guidelines
  • Organization and structure
  • Markup and formatting
  • Markup examples
  • Python docstrings
  • Docstring structure
  • Docstring examples
  • Style and quality checks