Skip to content

Commit

Permalink
move examples to redux-logic-examples repo
Browse files Browse the repository at this point in the history
In order to keep redux-logic's repo from thrashing due wo security updates on examples, move the examples to their own repo.
  • Loading branch information
jeffbski committed Jul 25, 2020
1 parent 0e2bdbf commit 3082c5c
Show file tree
Hide file tree
Showing 328 changed files with 269 additions and 128,835 deletions.
1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@
**/node_modules/**
**/server.js
**/webpack.config*.js
**/examples/**
13 changes: 0 additions & 13 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,3 @@ branches:
cache:
directories:
- $HOME/.npm
- examples/async-rxjs-ajax-fetch/node_modules
- examples/async-fetch-vanilla/node_modules
- examples/async-fetch-proc-options/node_modules
- examples/async-rxjs-ajax-proc-options/node_modules
- examples/async-await/node_modules
- examples/async-await-proc-options/node_modules
- examples/countdown/node_modules
- examples/countdown-obs/node_modules
- examples/form-validation/node_modules
- examples/notification/node_modules
- examples/search-async-fetch/node_modules
- examples/single-file/node_modules
- examples/single-file-redux/node_modules
32 changes: 9 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ If you cannot find your answer in the README or the docs, please check the issue

[GitHub issue tracker for redux-logic](https://github.com/jeffbski/redux-logic/issues)


### Help Us Help You

On both websites, it is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs.
Expand All @@ -38,6 +37,7 @@ git clone https://github.com/your-username/redux-logic.git
#### Building redux-logic

Running the `build` task will create both a CommonJS module-per-module build and a UMD build.

```
npm run build
```
Expand All @@ -51,6 +51,7 @@ npm run build:lib
The result will be in the `lib` folder.

To create just a UMD build:

```
npm run build:umd
npm run build:umd:min
Expand Down Expand Up @@ -130,36 +131,21 @@ npm run docs:clean

### Examples

redux-logic comes with [official examples](http://jeffbski.github.io/redux-logic/docs/introduction/Examples.html) to demonstrate various concepts and best practices.

When adding a new example, please adhere to the style and format of the existing examples, and try to reuse as much code as possible. For example, `index.html`, `server.js`, and `webpack.config.js` can typically be reused.

#### Building and Testing the Examples

To build and test the official Redux examples, run the following:

```
npm run build:examples
npm run test:examples
```

Not all examples have tests. If you see an example project without tests, you are very welcome to add them in a way consistent with the examples that have tests.

Please visit the [Examples page](http://jeffbski.github.io/redux-logic/docs/introduction/Examples.html) for information on running individual examples.
redux-logic comes with [official examples](http://jeffbski.github.io/redux-logic-examples/docs/introduction/Examples.html) to demonstrate various concepts and best practices. These live in a separate repo [redux-logic-examples](https://github.com/jeffbski/redux-logic-examples)

### Sending a Pull Request

For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don’t want you to waste your efforts on a pull request that we won’t want to accept.

On the other hand, sometimes the best way to start a conversation *is* to send a pull request. Use your best judgement!
On the other hand, sometimes the best way to start a conversation _is_ to send a pull request. Use your best judgement!

In general, the contribution workflow looks like this:

* Open a new issue in the [Issue tracker](https://github.com/jeffbski/redux-logic/issues).
* Fork the repo.
* Create a new feature branch based off the `master` branch.
* Make sure all tests pass and there are no linting errors.
* Submit a pull request, referencing any issues it addresses.
- Open a new issue in the [Issue tracker](https://github.com/jeffbski/redux-logic/issues).
- Fork the repo.
- Create a new feature branch based off the `master` branch.
- Make sure all tests pass and there are no linting errors.
- Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

Expand Down
269 changes: 131 additions & 138 deletions README.md

Large diffs are not rendered by default.

Loading

0 comments on commit 3082c5c

Please sign in to comment.