Skip to content

Latest commit

 

History

History
97 lines (72 loc) · 3.42 KB

Contributing.md

File metadata and controls

97 lines (72 loc) · 3.42 KB
Raw

Contribute to missing.css

Issues

PRs are not the only form of contributing. Reporting issues is also important and helps a lot. And, like PRs, issues that don't match the project's goals or standards of quality will not be accepted.

Don't be afraid! We take it upon ourselves to help people contribute. You might get follow-up questions or asked for more information when you submit an issue. It's not productive to close issues just because we don't like them.

For feature requests, prefer Discussions instead of Issues, unless the feature is directly in our RFP or Concepts pages. Otherwise, once a feature is agreed upon and there is interest in implementing it, issues can be created.

missing.css is developed on a "free to use, pay to demand" basis. Contributors are not beholden to users and can work on whatever they like. If you need a specific feature or bugfix for your business, consider putting up a bounty. (Not recommended: Making an unsolicited donation and then demanding. That's not how buying services works).

Development Environment

Node.js and npm are needed.

  • Get set up:

    npm install

  • Build just the CSS:

    npm run build

  • Build the website, which also builds the CSS:

    npm run www

  • Start a development server, which will watch the code and automatically refresh in the browser:

    npm run dev

Project Structure

  • src/ -- the CSS source code. This is processed with PostCSS (see build/).

    • main.css -- definitions used project-wide.

    • core/

      • sanitize.css -- a CSS reset

    • elements/ -- HTML elements, organized by spec

      • sections.css -- 4.1 The document element, 4.3 Sections
      • grouping.css -- 4.4 Grouping content
      • inline.css -- 4.5 Text-level semantics, 4.7 Edits
      • embedded.css -- 4.8 Embedded content
      • tabular.css -- 4.9 Tabular data
      • forms.css -- 4.10 Forms
      • interactive.css -- 4.11 Interactive elements

    • components/ -- components. Each component can be used as a class (<div class="my-component">),an attribute (<div my-component>) or a custom tag (<my-component>).

      Each component should have a documentation comment, explaining its purpose, appearance and usage.

    • shared/ -- base declarations that we use with @extend

      Avoid @extend-ing any style declarations outside this directory, and make sure that all rules inside this directory are %placeholder-rules. This way, we can always easily find the source of an @extend.

  • www/ -- the project website, built with eleventy

    • demos/ demo pages. These should have a name specified in the frontmatter. They will be listed in the demo page (../demos.md).

  • build/ -- buildscripts

    • postcss.js -- builds the CSS.

  • dist/ -- build results. This is also where the built website is.

    • missing.css -- unminified dev build
    • missing.min.css -- minified
    • missing.min.css.br -- minified + gzip compressed
    • missing.min.css.gz -- minified + brotli compressed