Feature/rebrand (#3)
This commit is contained in:
Daniel Lautzenheiser
committed by
GitHub
GitHub
parent
213e51c52d
commit
8acda23acc
110
CONTRIBUTING.md
110
CONTRIBUTING.md
@ -3,7 +3,7 @@
|
||||
Contributions are always welcome, no matter how large or small. Before contributing,
|
||||
please read the [code of conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
For details on contributing to documentation, see [Website Directory Readme](https://github.com/netlify/netlify-cms/blob/master/website/README.md).
|
||||
For details on contributing to documentation, see [Website Directory Readme](https://github.com/SimpleCMS/simple-cms/blob/main/website/README.md).
|
||||
|
||||
## Setup
|
||||
|
||||
@ -14,10 +14,9 @@ For details on contributing to documentation, see [Website Directory Readme](htt
|
||||
> Only required on the first run, subsequent runs can use `yarn start` to both bootstrap and run the development server.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/netlify/netlify-cms
|
||||
cd netlify-cms
|
||||
git clone https://github.com/SimpleCMS/simple-cms
|
||||
cd simple-cms
|
||||
yarn
|
||||
yarn bootstrap
|
||||
```
|
||||
|
||||
### Run locally
|
||||
@ -28,25 +27,9 @@ yarn start
|
||||
|
||||
## Available scripts
|
||||
|
||||
### bootstrap
|
||||
|
||||
Bootstraps the monorepo.
|
||||
|
||||
```sh
|
||||
yarn bootstrap
|
||||
```
|
||||
|
||||
### watch
|
||||
|
||||
Watches all CMS packages and transpiles them on change.
|
||||
|
||||
```sh
|
||||
yarn watch
|
||||
```
|
||||
|
||||
### start
|
||||
|
||||
Starts the development server. This task runs both the `bootstrap` and `watch` scripts.
|
||||
Starts the development server. This task runs both the `clean` and `develop` scripts.
|
||||
|
||||
```sh
|
||||
yarn start
|
||||
@ -60,62 +43,14 @@ Removes all of the CMS package `dist` directories.
|
||||
yarn clean
|
||||
```
|
||||
|
||||
### reset
|
||||
|
||||
Runs the `clean` script and removes all the `node_modules` from the CMS packages.
|
||||
|
||||
```sh
|
||||
yarn reset
|
||||
```
|
||||
|
||||
### build
|
||||
|
||||
Runs the `clean` script and builds the CMS packages.
|
||||
Runs the `clean` script and builds the simple-cms-core.
|
||||
|
||||
```sh
|
||||
yarn build
|
||||
```
|
||||
|
||||
### build-preview
|
||||
|
||||
Runs the `build` and `build-preview` scripts in each package and serves the resulting build locally.
|
||||
|
||||
```sh
|
||||
yarn build-preview
|
||||
```
|
||||
|
||||
### test
|
||||
|
||||
Runs linting and Jest tests.
|
||||
|
||||
```sh
|
||||
yarn test
|
||||
```
|
||||
|
||||
### test:all
|
||||
|
||||
Runs linting, Jest, and Cypress tests.
|
||||
|
||||
```sh
|
||||
yarn test:all
|
||||
```
|
||||
|
||||
### test:e2e
|
||||
|
||||
Runs Cypress e2e tests.
|
||||
|
||||
```sh
|
||||
yarn test:e2e
|
||||
```
|
||||
|
||||
### test:e2e:dev
|
||||
|
||||
Runs Cypress e2e tests on watch mode with an open instance of Chrome.
|
||||
|
||||
```sh
|
||||
yarn test:e2e:dev
|
||||
```
|
||||
|
||||
### format
|
||||
|
||||
Formats code and docs according to our style guidelines.
|
||||
@ -128,12 +63,12 @@ yarn format
|
||||
|
||||
We actively welcome your pull requests!
|
||||
|
||||
If you need help with Git or our workflow, please ask in our [community chat](https://netlifycms.org/chat). We want your contributions even if you're just learning Git. Our maintainers are happy to help!
|
||||
If you need help with Git or our workflow, please ask. We want your contributions even if you're just learning Git. Our maintainers are happy to help!
|
||||
|
||||
Netlify CMS uses the [Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) + [Feature Branches](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). Additionally, PR's should be [rebased](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) on master when opened, and again before merging.
|
||||
Simple CMS uses the [Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) + [Feature Branches](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). Additionally, PR's should be [rebased](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) on main when opened, and again before merging.
|
||||
|
||||
1. Fork the repo.
|
||||
2. Create a branch from `master`. If you're addressing a specific issue, prefix your branch name with the issue number.
|
||||
2. Create a branch from `main`. If you're addressing a specific issue, prefix your branch name with the issue number.
|
||||
3. If you've added code that should be tested, add tests.
|
||||
4. If you've changed APIs, update the documentation.
|
||||
5. Run `yarn test` and ensure the test suite passes.
|
||||
@ -154,28 +89,8 @@ backend:
|
||||
repo: owner-name/repo-name
|
||||
```
|
||||
|
||||
2. Change the content of `dev-test/index.html` to:
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Netlify CMS</title>
|
||||
</head>
|
||||
<body>
|
||||
<script src="dist/netlify-cms-core.js"></script>
|
||||
<!-- <script>
|
||||
// this is the place to add CMS customizations if you need to, e.g.
|
||||
CMS.registerPreviewTemplate('posts', PostPreview);
|
||||
</script> -->
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
The most important thing is to make sure that Netlify CMS is loaded from the `dist` folder. This way, every time you make changes to the source code, they will be compiled and reflected immediately on `localhost`.
|
||||
|
||||
3. Run `yarn start`
|
||||
4. Open `http://localhost:8080/` in the browser and you should have access to the CMS
|
||||
2. Run `yarn start`
|
||||
3. Open `http://localhost:8080/` in the browser and you should have access to the CMS
|
||||
|
||||
### Debugging Git Gateway
|
||||
|
||||
@ -204,8 +119,6 @@ The first part of the command, `yarn jest` means running the locally installed v
|
||||
|
||||
Example for running all the tests for the file `gitlab.spec.js`: `yarn jest gitlab.spec.js`
|
||||
|
||||
Some test files like `API.spec.js` is available in several packages. You can pass a regexp pattern instead of file path to narrow down files.
|
||||
|
||||
Example for running all the tests for the file `API.spec.js` in the `gitlab` package:
|
||||
|
||||
`yarn jest ".+backend-gitlab/.+/API.spec.js`
|
||||
@ -222,5 +135,4 @@ For more information about running tests exactly the way you want, check out the
|
||||
|
||||
## License
|
||||
|
||||
By contributing to Netlify CMS, you agree that your contributions will be licensed
|
||||
under its [MIT license](LICENSE).
|
||||
By contributing to Simple CMS, you agree that your contributions will be licensed under its [MIT license](LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user