Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

82 lines (49 loc) · 2.93 KB

Beercss Contributing Guide

Hi! We are really excited that you are interested in contributing to Beercss! Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

Issue Reporting Guidelines

  • None at moment :)

Pull Request Guidelines

  • The main branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the main branch.

  • Checkout a topic branch from the relevant branch, e.g. dev, and merge back against that branch.

  • Work in the src folder and DO NOT checkin dist in the commits.

  • It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.

  • Make sure npm run test passes. (see development setup)

  • If adding a new feature:

    • Add accompanying test case.
    • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

  • If fixing bug:

    • If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your PR title for a better release log, e.g. update entities encoding/decoding (fix #3899).
    • Provide a detailed description of the bug in the PR. Live demo preferred.
    • Add appropriate test coverage if applicable.

Development Setup

You will need Node.js.

After cloning the repo, run:

$ npm install

Commonly used NPM scripts

# watch and opens a brownser
$ npm run dev

# build all dist files, including npm packages
$ npm run build

# run the full test suite, including linting/type checking
$ npm run test

Project Structure

  • build: contains build-related scripts and configuration files. Usually, you don't need to touch them. However, it would be helpful to familiarize yourself with the following files:

  • dist: contains built files for distribution. Note this directory is only updated when a release happens; they do not reflect the latest changes in development branches.

  • src: contains the source code.

    • cdn: contains files that will be used for cdn/npm

    • home: contains a homepage for Beer css!

    • shared: contains utilities shared across the entire codebase.

    • static: contains static files.

    • test: contains a blank test page for use in your tests. It will be available in npm run dev at url http://localhost:3030/test

  • tests: contains all tests. The unit tests are written with Vitest.

Credits

Thank you to all the people who have already contributed to Beercss!