diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cee152b..d5fe715 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,6 @@ - [Introduce](#introduce) * [Code of Conduct](#code-of-conduct) * [We Develop with Github](#we-develop-with-github) - * [Environment](#environment) * [Your First Contribution](#your-first-contribution) * [Contribution Targets](#contribution-targets) - [License](#license) @@ -34,38 +33,6 @@ We use [github](https://github.com/black7375/Firefox-UI-Fix) to host code, to tr After feedback has been given we expect responses within two weeks. After two weeks we may close the issue and pull request if it isn't showing any activity. -### Environment -[`git`](https://git-scm.com/) and [`yarn`](https://yarnpkg.com/) should be installed. - -You can configure it as follows: -```shell -## clone repository -git clone https://github.com/black7375/Firefox-UI-Fix.git -cd ./Firefox-UI-Fix - -## checkout branch -git checkout - -## env setup -yarn install -``` - -You can build with this command: -```shell -yarn build -``` - -You can check test and css validate: -```shell -## test - When you make mixin or function -# __tests__ direcory, You can also find out how to use internal utils. -yarn test - -## validate - Will be failed, this project uses non-standard features. -# Just use only for checking. -yarn validate -``` - ### Your First Contribution **Working on your first Pull Request?** diff --git a/docs/README.md b/docs/README.md index 639291b..44813c5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,6 +5,7 @@ - [Basics](#basics) - [Project-Specific](#project-specific) + * [Environment](#environment) * [Project Structure](#project-structure) * [Rules](#rules) - [User Custom CSS](#user-custom-css) @@ -29,6 +30,38 @@ Test for None mac users: - [Docker-OSX](https://github.com/sickcodes/Docker-OSX) ## Project-Specific +### Environment +[`git`](https://git-scm.com/) and [`yarn`](https://yarnpkg.com/) should be installed. + +You can configure it as follows: +```shell +## clone repository +git clone https://github.com/black7375/Firefox-UI-Fix.git +cd ./Firefox-UI-Fix + +## checkout branch +git checkout + +## env setup +yarn install +``` + +You can build with this command: +```shell +yarn build +``` + +You can check test and css validate: +```shell +## test - When you make mixin or function +# __tests__ direcory, You can also find out how to use internal utils. +yarn test + +## validate - Will be failed, this project uses non-standard features. +# Just use only for checking. +yarn validate +``` + ### Project Structure - [Project\_Structure.md](./Project_Structure.md).