https://github.com/speced/bikeshed-boilerplate

Boilerplate files for Bikeshed specs
https://github.com/speced/bikeshed-boilerplate

Last synced: about 1 month ago
JSON representation

Boilerplate files for Bikeshed specs

• Host: GitHub
• URL: https://github.com/speced/bikeshed-boilerplate
• Owner: speced
• License: apache-2.0
• Created: 2021-09-16T18:07:03.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-23T04:30:53.000Z (4 months ago)
• Last Synced: 2024-05-23T04:53:47.116Z (4 months ago)
• Language: Python
• Size: 499 KB
• Stars: 4
• Watchers: 4
• Forks: 27
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bikeshed Boilerplate

This repo holds the boilerplate files (header, footer, other "constant" bits of specs) used by [Bikeshed](https://github.com/tabatkins/bikeshed).

The top-level files in the `boilerplate/` folder are used by default,

if there's nothing more specific.

The subfolders are for specific groups (the `Group` metadata in a Bikeshed file) to override the defaults with group-specific variants. In there, the filename may also have a status (the `Status` metadata in the Bikeshed file) to further specialize them.

## Altering Boilerplates

If you need to change an existing boilerplate for your group,

just send a PR.

## Adding or Removing Boilerplates

If you need to add or remove files from an existing group's folder,

send a PR.

I will additionally need to regenerate the manifest,

so it might be delayed until I'm at a work computer.

If you're adding files for a new group,

look for an existing group's files that generate specs that look similar to what you want.

If you're a W3C group, start with the contents of the `boilerplates/w3c/` folder.

## Testing Boilerplates Before Adding Them Here

If you want to verify that your new or updated boilerplates work the way you want before you PR this repo,

just put the boilerplates in question into the same folder as your spec file.

Bikeshed looks for boilerplates in the spec's folder first,

before it starts searching thru its own data files.

(If you're using the API version of Bikeshed, or passing Bikeshed a spec on stdin,

there's no way to test new boilerplates.

Install it locally from `pipx` and put the spec into a file.)

## When Are Boilerplates Available?

After a boilerplate change has been merged,

a PR will be automatically created with the appropriate changes to the manifest file.

(This can be done manually by running `./update-manifest` in this folder).

Once that PR is merged, a few minutes later the change will be picked up by [bikeshed-data](https://github.com/tabatkins/bikeshed-data)

(check the commit log to see it),

at which point a `bikeshed update` will bring the new boilerplates in.

Alternately, manually updating the boilerplates with `bikeshed update --skip-manifest --boilerplate` will pull the new files down immediately,

without waiting for `bikeshed-data` to update.