Michel2/pybricks-code
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-code.git synced 2026-07-28 04:08:05 +00:00
Code Issues Releases Activity

Clarify how to contribute and point out github registry pitfall

Browse Source
This commit is contained in:
Andreas Litt
2020-12-13 20:03:31 +01:00
parent effca9e81b
commit 838d0c88b7
2 changed files with 29 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+23 -30
View File
@@ -4,6 +4,28 @@
These are the tools you will need to build and run `pybricks-code` locally.
## Important Note about Github Packages
**This step is mandatory and cannot be skipped. Otherwise you will have no access to some referenced dependencies in [package.json](./package.json)!**
We are currently depending on a couple of packages from the Github package
registry. [Github requires you](https://docs.github.com/en/free-pro-team@latest/packages/guides/configuring-npm-for-use-with-github-packages#authenticating-with-a-personal-access-token) to log in first before you can install public packages.
To do this, first you will need to create a new authentication token at
<https://github.com/settings/tokens>.
- Click the *Generate a new token* button.
- Select the **repo** and **read:packages** scopes.
- Click the *Generate token* button.
- Click the clipboard icon top copy the token to be used below.
Then run the following command and enter your username, authentication token
and email:
npm login --registry=https://npm.pkg.github.com
This only needs to be done once.
## IDE
Technically you can use any text editor you like but the project is set up to
@@ -12,7 +34,6 @@ will do nice things like automatically format the code for you.
[vscode]: https://code.visualstudio.com/
## Toolchain
These are the required software tools you need to install on your computer.
@@ -38,28 +59,6 @@ You will need [Git][git] to get the source code from GitHub. (Say that 3 times f
[git]: https://git-scm.com/
## Github Packages
We are currently depending on a couple of packages from the Github package
registry. This requires you to log in first before you can install the packages.
To do this, first you will need to create a new authentication token at
<https://github.com/settings/tokens>.
- Click the *Generate a new token* button.
- Select the **repo** and **read:packages** scopes.
- Click the *Generate token* button.
- Click the clipboard icon top copy the token to be used below.
Then run the following command and enter your username, authentication token
and email:
npm login --registry=https://npm.pkg.github.com
This only needs to be done once.
## Getting The Code
After the tools above have been installed, open a command prompt in the directory
@@ -70,7 +69,7 @@ where you would like to save the source code and run:
yarn install
If you see a 401 not authorized error after running `yarn install`, then you
probably skipped the logging into the Github package registry as described above.
probably skipped the logging into the Github package registry as [described above](#important-note-about-github-packages).
# Software Stack
@@ -78,12 +77,10 @@ This project was bootstrapped with [Create React App][create-react-app].
[create-react-app]: https://github.com/facebook/create-react-app
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.
@@ -99,19 +96,16 @@ The page will reload if you make edits.
You will also see any lint errors in the console.
### `yarn lint`
Runs the code linter.
This will automatically fix most lint errors for you.
### `yarn test`
See [README](test/README.md) in the `test/` directory.
### `yarn build`
Builds the app for production to the `build` folder.
@@ -127,7 +121,6 @@ See the section about [deployment][deployment] for more information.
[deployment]: https://facebook.github.io/create-react-app/docs/deployment
## Learn More
You can learn more in the [Create React App documentation][create-react-app-doc].
README.md
+6
View File
@@ -10,3 +10,9 @@ A Web App for programming LEGO® Powered Up smart hubs using Pybricks MicroPytho
---
<small>LEGO® is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this project</small>
# Contributing
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.
For more details, see the file [CONTRIBUTING.md](./CONTRIBUTING.md).