atlassian-labs / compiled

A familiar and performant compile time CSS-in-JS library for React.
https://compiledcssinjs.com
Apache License 2.0
1.98k stars 68 forks source link

Add custom GitHub action and pull request template to enforce that documentation is updated #1694

Closed dddlr closed 1 month ago

dddlr commented 1 month ago

Added a pull request template with a checklist that asks that documentation be updated for every PR.

This is enforced by a custom GitHub action that checks whether any tasks in the checklist are marked as incomplete. If any are incomplete, the GitHub action will give an error.

You can exempt parts the PR description from the incomplete task check by adding <!-- task-checklist-ignore-start --> and <!-- task-checklist-ignore-end --> around the sections where you want to disable the check.


Test it out here!

Screenshot 2024-07-16 at 11 32 59

Screenshot 2024-07-16 at 11 34 14


Alternative methods considered for finding incomplete tasks in the PR description:

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: ac49a30008e0a5cb04709ff8dd6825c313d5bb7f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

netlify[bot] commented 1 month ago

Deploy Preview for compiled-css-in-js canceled.

Name Link
Latest commit ac49a30008e0a5cb04709ff8dd6825c313d5bb7f
Latest deploy log https://app.netlify.com/sites/compiled-css-in-js/deploys/6695f494bb61e90009b7b093