Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 1.68 KB

Contributing

Thanks for contributing to CSS Base! We're quite open to new feature requests, or any work you want to do.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Creating Issues

When creating issues please follow the according template structure:

Contributor Workflow

The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests". This facilitates social contribution, easy testing and peer review.

To contribute a patch, the workflow is as follows:

  • Fork repository
  • Create topic branch
  • Commit patches

If you send a pull request, please do it against the master branch.

Set up a local dev environment

To set up a local dev environment following steps are required:

  1. Fork this repository
  2. Clone:
git clone [email protected]:[YOUR_USERNAME]/css-base.git
  1. Install parcel via https://parceljs.org/getting_started.html
  2. Watch:
yarn start

or

npm start
  1. Open http://localhost:1234/ in your browser. Find out more at parceljs.org.

Codestyle

This project uses Standard JS to validate and lint javascript code:

  • A single indentation is equal to two spaces;
  • A sinle line break should follow after every CSS rule;
  • No use of semicolon in JavaScript;
  • Use ES6 syntax when possible;
  • Use singlequote over doublequotes in JavaScript files.