Skip to content
This repository has been archived by the owner on Oct 22, 2023. It is now read-only.

Introduce new change set type: documentation #8

Open
1 task
alrik opened this issue Feb 19, 2018 · 3 comments
Open
1 task

Introduce new change set type: documentation #8

alrik opened this issue Feb 19, 2018 · 3 comments

Comments

@alrik
Copy link
Member

alrik commented Feb 19, 2018

Documentation is an essential part of good software, thus it deserves an own area within a release statement.

I see 3 options for naming the new modification type:

  • docs
  • documentation
  • or both with docs being alias of documentation

I like docs best. It is short and commonly used. documentation sound more official but is a quite long word. Having both options will bloat up the spec without much use.

Acceptance Criteria

  • Add specification of new modification type for labeling documentation changes
@alrik
Copy link
Member Author

alrik commented Feb 19, 2018

@derlarsen @baranga @IjzerenHein do you have any feedback on this?

@baranga
Copy link

baranga commented Feb 19, 2018

@alrik Could you provide a example of usage?

@alrik
Copy link
Member Author

alrik commented Feb 19, 2018

I'd use it for statements like these:

title: Release Notes of an awesome project
releases:
- version: Unreleased
  added:
  - Add some fancy feature.
  docs:
  - Add an [example](examples/fancy-feature/) on how to use fancy feature.
  - Fixed api status code description of some legacy feature.
  - Setup code of conduct and introduce getting started tutorial.
  - Update license year in all code doc block annotations.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants