LBRYCommunity/lbry-desktop
1
0
Fork 0
Code Issues 596 Pull requests 6 Projects Releases 238 Packages Wiki Activity

CONTRIBUTING.MD: remove electron and other app references

Browse source
This commit is contained in:
infinite-persistence 2022-06-02 14:11:09 +08:00 committed by GitHub
parent 227b6e3011
commit c677f69c60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md
View file

@ -63,14 +63,13 @@ Although all contributions should have good UX, the [UX label, when applied in c
## Code Overview ## Code Overview
The entry point for this application is [`electron/index.js`](https://github.com/OdyseeTeam/odysee-frontend/blob/master/electron/index.js). This application is primarily written in JavaScript, utilizing [React](https://reactjs.org) and [Redux](https://redux.js.org) for UI and
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. application state.
The project comes with diverse tools for simplifying the development process and for providing 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](https://airbnb.io/javascript/) for defining better code quality. It's recommended to make use of them thoroughly during ongoing development.
We follow the well-known [Airbnb JavaScript Style Guide](https://airbnb.io/javascript/) for defining
our styling rules and code best practices. our styling rules and code best practices.
### Flow ### Flow
@ -133,7 +132,6 @@ There are a few tools integrated to the project that will ease the process of de
- [Chrome DevTools](https://developer.chrome.com/devtools) - [Chrome DevTools](https://developer.chrome.com/devtools)
- Also available for the main process as a [remote target](chrome://inspect/#devices). - Also available for the main process as a [remote target](chrome://inspect/#devices).
- [Electron Devtron](https://electronjs.org/devtron)
- [React DevTools](https://github.com/facebook/react-devtools) - [React DevTools](https://github.com/facebook/react-devtools)
- [Redux DevTools](https://github.com/gaearon/redux-devtools) - [Redux DevTools](https://github.com/gaearon/redux-devtools)
@ -142,14 +140,12 @@ There are a few tools integrated to the project that will ease the process of de
- After deciding what to work on, a potential contributor can - After deciding what to work on, a potential contributor can
[fork](https://help.github.com/articles/fork-a-repo/) this repository, make his or her changes, [fork](https://help.github.com/articles/fork-a-repo/) this repository, make his or her changes,
and submit a and submit a
[pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). A [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
contributor wanting to reserve an issue in advance can leave a comment saying that he or she is - A contributor wanting to reserve an issue in advance can leave a comment saying that he or she is
working on it. Contributors should respect other people's efforts to complete issues in a timely working on it. Contributors should respect other people's efforts to complete issues in a timely
manner and, therefore, not begin working on anything reserved (or updated) within the last 3 days. manner and, therefore, not begin working on anything reserved (or updated) within the last 3 days.
If someone has been officially assigned an issue via GitHub's assignment system, it is also not If someone has been officially assigned an issue via GitHub's assignment system, it is also not
available. Contributors are encouraged to ask if they have any questions about issue availability. available. Contributors are encouraged to ask if they have any questions about issue availability.
- The [changelog](https://github.com/OdyseeTeam/odysee-frontend/blob/master/CHANGELOG.md) should be updated to
include a reference to the fix/change/addition. See previous entries for format.
- Once the pull request is visible in the Odysee repo, a Odysee team member will review it and make sure - Once the pull request is visible in the Odysee repo, a Odysee team member will review it and make sure
it is up to our standards. At this point, the contributor may have to change his or her code based it is up to our standards. At this point, the contributor may have to change his or her code based
on our suggestions and comments. on our suggestions and comments.