mirror of
https://github.com/black7375/Firefox-UI-Fix.git
synced 2025-12-06 02:30:54 -08:00
Doc: Environment - Move to docs/README.md
This commit is contained in:
parent
16c0ae0410
commit
54d7fa9e3d
2 changed files with 33 additions and 33 deletions
|
|
@ -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 <BRANCH_NAME>
|
||||
|
||||
## 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?**
|
||||
|
|
|
|||
|
|
@ -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 <BRANCH_NAME>
|
||||
|
||||
## 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).
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue