simple.css is an open source project, meaning that anyone can contribute and make changes. To become a contributor to simple.css, follow these steps:
Basic information:
- Pick an issue that you're willing to work on
- Open new issue if it's an improvement instead of a problem, wait for response of repository owner, before you begin
Prerequisites
This project uses Gulp JS
as its task-runner. It will basically take all of the scss
and js
, pre-process, compile, minify and do all of
the boring things that you shouldn't do, so you must have Node JS and NPM installed.
- Visit Node JS and download the latest version (current, not LTS)
Fork and clone:
- Fork the repository
- Clone forked repository
git clone https://github.com/username/simple.css.git
(make sure to replaceusername
with your actual GitHub username)
Before you start making any contributions:
Now that you have Node JS and NPM installed, you can access it through terminal/cmd
. Commands below are required for development and contribution.
COMMAND | DESCRIPTION |
---|---|
npm install |
it will install all dependencies of this project and its development |
npm run dev |
it will trigger npm script that runs gulp task-runner and compiles everything for the first time for development |
npm run prod |
it will trigger npm script that runs gulp with --production flag; which compiles everything for production |
npm run clean |
it removes the dist directory; you mostlikely won't need to run this command ever, it will ran automatically on each compile dev or prod |
npm run watch |
it will watch for any changes you make in src directory while developing |
To sum it up, you will basically need to follow these commands after you forked
and cloned
repository...
cd ~/Sites/simple.css/
(change directory to where you cloned the repository, this most likely might not be your path)npm install
(to install all dependencies for the first time)npm run dev && npm run watch
(to compile it for development for the first time and to watch for further changes)
Begin with work:
Every source file is located within src
directory and that's where you should be making your changes, unless it's index.html
or docs
improvement.
Once you finish with all your changes that solves an issue
, push your changes to github and submit a pull request.