wayfair-incubator / oss-template Goto Github PK

Problem Statement

Initially, when developing this template, we wanted to be as un-opinionated as possible, while still enforcing minimum standards for our open source projects. In practice, however, the overwhelming majority of our new/incubating projects go on to select the MIT license. In addition, by not including a default license in the template, we run the risk of some projects launching without selecting a license, and only finding out through organizational audits later on.

Proposed Solution

We should include the MIT license by default, and instruct project maintainers (via README) to confirm that this license is appropriate for their project needs, while also providing steps to change the license to one of our other supported options (eg. BSD, Apache, Mozilla) if MIT is not suitable.

Description

https://github.com/wayfair-incubator/oss-template/blob/main/CHANGELOG.md is missing the anchor links as seen on https://keepachangelog.com/en/1.0.0/ (e.g., scroll within the text area on that page until you see:

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

Expected Behaviour

Anchor links are included at the bottom of CHANGELOG.md so that the [X.Y.Z] references properly link in when the markdown file renders.

Actual Behaviour

Anchor links are missing so [X.Y.Z] references only show the version number and do not link as shown in the Keep A Changelog standard.

Affected Version

All versions.

Steps to Reproduce

1. Go to https://github.com/wayfair-incubator/oss-template/blob/main/CHANGELOG.md
2. See [0.3.7] - 2022-04-04 and that [0.3.7] doesn't link to the expected v0.3.6...v0.3.7

Checklist

• I have read the contributing guidelines
• I have verified this does not duplicate an existing issue

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Problem Statement

This template, which consists primarily of markdown, needs to be linted manually before each pull request. This introduces additional toil.

Proposed Solution

Implement a CI pipeline to lint Markdown and block merging of failing pull requests.

Alternatives Considered

Continue doing it manually. It's not a ton of work, but it is a question of when we forget, not if.

Additional Context

Comment initially proposing this change