From 262a854ad4d7a1ccc851050af61ada0e688c7159 Mon Sep 17 00:00:00 2001 From: Sean Yesmunt Date: Mon, 14 May 2018 23:55:12 -0400 Subject: [PATCH] add info for resetting packages and lbry-redux --- CONTRIBUTING.md | 16 ++++++++++++---- README.md | 4 ++++ 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e1c523bc..45de69dec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ # Contribute to LBRY -You found this page! That means you are well on your way to contributing to the LBRY app. This -application is primarily written in JavaScript and is built on [Electron](https://electronjs.org) -while utilizing [React](https://reactjs.org) and [Redux](https://redux.js.org) for UI and -application state. + +**First:** if you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. You won't be yelled at for giving your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that. + +However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document will cover what we're looking for. By addressing all the points we're looking for, it raises the chances we can quickly merge or address your contributions. ## TL;DR? @@ -57,10 +57,18 @@ Although all contributions should have good UX, the [UX label, when applied in c The entry point for this application is `src/renderer/index.js` +This application is primarily written in JavaScript and is built on [Electron](https://electronjs.org) +while utilizing [React](https://reactjs.org) and [Redux](https://redux.js.org) for UI and +application state. + The project comes with diverse tools for simplifying the development process and for providing better code quality. It's recommended to make use of them thoroughly during ongoing development. We follow the well-known [Airbnb JavaScript Style Guide](http://airbnb.io/javascript/) for defining our styling rules and code best practices. +### lbry-redux + +We have started sharing some of the redux code for this project with [lbry-android](https://github.com/lbryio/lbry-android). This shared code is in a github repo called [lbry-redux](https://github.com/lbryio/lbry-redux). We plan to move additional redux code to that repo, so you may be asked to make some of your changes there. The steps to work with lbry-redux locally can be found [here](https://github.com/lbryio/lbry-redux#local-development). + ### Flow [Flow](https://flow.org/) is a static type checker for JavaScript. Flow checks your code for diff --git a/README.md b/README.md index cff3052cd..c216d9738 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,10 @@ Double click the installed application to browse with the LBRY network. If you want to just build the app you can run `yarn build`. This will give you an executable inside the `/dist` folder. We use [electron-builder](https://github.com/electron-userland/electron-builder) to create distributable packages. +#### Resetting your Packages + +If the app isn't building, or `yarn xxx` commands aren't working you may need to just reset your `node_modules`. To do so you can run: `rm -r node_modules && yarn` + ## Contributing Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md)