mirror of
https://github.com/kognise/water.css.git
synced 2025-08-07 21:56:42 +02:00
Add Changesets and update documentation
This commit is contained in:
8
.changeset/README.md
Normal file
8
.changeset/README.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Changesets
|
||||||
|
|
||||||
|
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
|
||||||
|
with multi-package repos, or single-package repos to help you version and publish your code. You can
|
||||||
|
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
|
||||||
|
|
||||||
|
We have a quick list of common questions to get you started engaging with this project in
|
||||||
|
[our documentation](https://github.com/changesets/changesets/blob/master/docs/common-questions.md)
|
9
.changeset/config.json
Normal file
9
.changeset/config.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://unpkg.com/@changesets/config@1.1.0/schema.json",
|
||||||
|
"changelog": "@changesets/cli/changelog",
|
||||||
|
"commit": false,
|
||||||
|
"linked": [],
|
||||||
|
"access": "restricted",
|
||||||
|
"baseBranch": "master",
|
||||||
|
"updateInternalDependencies": "patch"
|
||||||
|
}
|
53
.github/CONTRIBUTING.md
vendored
53
.github/CONTRIBUTING.md
vendored
@@ -4,27 +4,21 @@ Water.css becomes better for everyone when people like you help make it better!
|
|||||||
|
|
||||||
Have any questions or concerns? Did I forget an element or selector? Does something look ugly? Feel free to submit an issue or pull request.
|
Have any questions or concerns? Did I forget an element or selector? Does something look ugly? Feel free to submit an issue or pull request.
|
||||||
|
|
||||||
Before contributing, please read the [code of conduct](CODE_OF_CONDUCT.md). Also you agree that your contributions will be licensed under its [MIT License](./LICENSE.md).
|
Before contributing, please read the [code of conduct](CODE_OF_CONDUCT.md). Also you agree that your contributions will be licensed under its [MIT License](../LICENSE.md).
|
||||||
|
|
||||||
## How to get started
|
## How to get started
|
||||||
|
|
||||||
1. Get a copy of repository. It is recommended to fork it first and clone to your machine using `git`.
|
1. Get a copy of repository. It is recommended to fork it first and clone to your machine using `git`.
|
||||||
|
|
||||||
2. Make sure that you have [yarn](https://yarnpkg.com) and install dependencies listed in `package.json` using it.
|
2. Make sure that you have [yarn](https://yarnpkg.com) and install dependencies listed in `package.json` using it.
|
||||||
|
```
|
||||||
```
|
yarn
|
||||||
yarn
|
```
|
||||||
```
|
|
||||||
|
|
||||||
3. Then you can run development server with live reloading out of the box and play around with the framework.
|
3. Then you can run development server with live reloading out of the box and play around with the framework.
|
||||||
|
```
|
||||||
|
yarn dev
|
||||||
|
```
|
||||||
|
|
||||||
```
|
So you can access the `index.html` in browser by visiting [localhost:3000](http://localhost:3000/)
|
||||||
yarn dev
|
|
||||||
```
|
|
||||||
|
|
||||||
So you can access the `index.html` in browser by visiting http://localhost:3000/index.html
|
|
||||||
|
|
||||||
More details will be provided in command line interface.
|
|
||||||
|
|
||||||
*Note.* A script that builds distribution ready files is also available but it is not the part of development workflow, it is designed to be triggered automatically while publishing a new version of a package. The script itself could be run manually:
|
*Note.* A script that builds distribution ready files is also available but it is not the part of development workflow, it is designed to be triggered automatically while publishing a new version of a package. The script itself could be run manually:
|
||||||
|
|
||||||
@@ -44,18 +38,37 @@ Also everyone is welcome to contribute on issues tagged with `help wanted`, you
|
|||||||
|
|
||||||
It is a few general rules of thumb about making pull requests:
|
It is a few general rules of thumb about making pull requests:
|
||||||
|
|
||||||
* Make sure that your pull request covers a small and well defined scope
|
- Make sure that your pull request covers a small and well defined scope
|
||||||
|
- Make small commits with clear and explainful messages
|
||||||
|
- You need to provide a clear description about your contribution on GitHub
|
||||||
|
|
||||||
* Make small commits with clear and explainful messages
|
Before making a pull request, make sure you lint your code and generate a changelog.
|
||||||
|
|
||||||
* You need to provide a clear description about your contribution on GitHub
|
**Linting**
|
||||||
|
|
||||||
|
If you aren't familiar, a linter is a program that automatically checks your code for formatting issues and potential bugs. Our linters are configured to automatically fix what they can so you can typically run one command and be done with it:
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn lint
|
||||||
|
```
|
||||||
|
|
||||||
|
**Changelogs**
|
||||||
|
|
||||||
|
We use software called Changesets to keep track of what changes have been made between versions. Make sure to create a changelog before creating your pull request!
|
||||||
|
|
||||||
|
Just run this command, and then answer a few questions:
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn changeset
|
||||||
|
```
|
||||||
|
|
||||||
## Directory structure
|
## Directory structure
|
||||||
|
|
||||||
```
|
```
|
||||||
.
|
.
|
||||||
├── dist
|
├── dist
|
||||||
├── icons
|
└── docs
|
||||||
|
└── icons
|
||||||
└── src
|
└── src
|
||||||
├── assets
|
├── assets
|
||||||
├── builds
|
├── builds
|
||||||
@@ -64,7 +77,9 @@ It is a few general rules of thumb about making pull requests:
|
|||||||
|
|
||||||
`dist` directory is ignored by git and it contains built assets for distribution
|
`dist` directory is ignored by git and it contains built assets for distribution
|
||||||
|
|
||||||
`icons` directory contains water.css favicons used in `index.html` demo/docs file
|
`docs` directory contains the documentation and demo page
|
||||||
|
|
||||||
|
`docs/icons` directory contains water.css favicons used in the documentation
|
||||||
|
|
||||||
`src` directory contains all the source stylesheets groupped into folders and variables
|
`src` directory contains all the source stylesheets groupped into folders and variables
|
||||||
|
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "water.css",
|
"name": "water.css",
|
||||||
"version": "2.0.0",
|
"version": "1.4.0",
|
||||||
"description": "A just-add-css collection of styles to make simple websites just a little nicer.",
|
"description": "A just-add-css collection of styles to make simple websites just a little nicer.",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@@ -29,6 +29,7 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@babel/core": "^7.4.5",
|
"@babel/core": "^7.4.5",
|
||||||
"@babel/preset-env": "^7.4.5",
|
"@babel/preset-env": "^7.4.5",
|
||||||
|
"@changesets/cli": "^2.7.2",
|
||||||
"@ungap/url-search-params": "^0.1.2",
|
"@ungap/url-search-params": "^0.1.2",
|
||||||
"autoprefixer": "^9.5.1",
|
"autoprefixer": "^9.5.1",
|
||||||
"browser-sync": "^2.26.3",
|
"browser-sync": "^2.26.3",
|
||||||
|
Reference in New Issue
Block a user