Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Worker fix #137

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [1.8.5](https://github.com/elilambnz/react-py/compare/v1.8.4...v1.8.5) (2023-02-10)
### [1.8.5-alpha.2](https://github.com/elilambnz/react-py/compare/v1.8.5-alpha.1...v1.8.5-alpha.2) (2023-01-29)

### [1.8.5-alpha.1](https://github.com/elilambnz/react-py/compare/v1.8.5-alpha.0...v1.8.5-alpha.1) (2023-01-29)

### [1.8.5-alpha.0](https://github.com/elilambnz/react-py/compare/v1.8.4...v1.8.5-alpha.0) (2023-01-29)

### [1.8.4](https://github.com/elilambnz/react-py/compare/v1.8.3...v1.8.4) (2023-01-21)

Expand Down
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,41 @@ npm run build && npm test
```

Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.

## Development

Developing react-py locally requires some additional steps.

You'll need to install [Node.js](https://nodejs.org/en/). Once you have Node.js installed, you can install the project's dependencies by running:

```sh
git clone [email protected]:elilambnz/react-py.git
cd react-py
npm install
```

This repo also contains the documentation site, which can be used to test your changes. To get started with the website, run:

```sh
cd website
npm install
npm run start
```

You will need to link the local version of react-py to the website. To do this, run in the root of the project:

```sh
npm link
```

Then, in the website directory, run:

```sh
npm link react-py
```

Now, you can make changes to the react-py code and see the changes reflected in the website.

TIP: You can use the `npm run watch` command to automatically rebuild and run `npm link` when you make changes.

NOTE: When using React and `npm link`, this can cause issues with multiple copies of React being loaded. A webpack plugin `resolveReact` has been added to the Docusaurus config to resolve this issue.
Loading