plone / plone/mockup

Add .documentation extension for release-it

Open Beginner friendly
#1,373 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
57
Forks
103
Avg merge
10h 25m
Merged PRs (30d)
18

Description

Other repos also have:

-   Documentation (type: `documentation`)

.doc opens in Word and other office apps by default, and this file extension is explicit.

Is that something you want to add?

Originally posted by @stevepiercy in https://github.com/plone/mockup/pull/1345#discussion_r1379785053


The answer is "yes"!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the release-it configuration and the existing file-extension declarations in the repository. Add the explicit .documentation extension alongside the current entries, then verify that release-it recognizes it consistently with the documented type.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
release
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.