- Copy repo URL into your Github Desktop or CLI and clone to your local machine
- Install node globally on your pc if you havent already: https://nodejs.org/en/download/
- Install yarn globally on your pc if you havent already: https://yarnpkg.com/
- Install Visual Studio Code (or your preferred editor) to your pc: https://code.visualstudio.com/
- Now that you have the project ready; let's get your editor setup and using the prettier formatting rules to ensure your code changes are being formatted based on the rules of the project
- Start by opening your project in your editor; ideally do this through GitHub desktop to ensure the project is scoped in the editor:
- Go to the extensions section:
- Install
ESLint& alsoPrettier - Code formatter
- Open any of the project's .js files and right click the code editor and select
Format Document
- Then change to
Prettierfor the formatter selection box:
- Optional but recommended: change project to auto-format on save.
- To change this setting, use Command + , on Mac or Control + , on Windows to open the settings menu. Then search for Editor: Format on Save and make sure it is checked.
- Now that you have project and editor setup and ready; it's time to make sure the project grabs all the external dependencies it needs
- Open the terminal in Visual Studio ( Cntrl + ` )
- Type and run
yarnin the project directory to get all dependencies loaded into your local project folder - Your project is now setup and good to go!
-
Open the terminal in Visual Studio ( Cntrl + ` )
-
Then run 'yarn start' in the project directory and a localhost window will pop up with your local project running live for you to preview as you change the code (magic!?)
-
Ready to contribute? Reach out in the community telegram to get connected with an online contributor who will put you through to the contributors channel. In the meantime:
- Browse the issues list for an issue you want to work on: https://github.com/spartan-protocol/SpartanProtocol-DAppV2/issues
- Assign it to yourself (reach out if you want advice or permissions)
- Create a new branch with the Github Issue ID in it and some sort of a short descriptor of your choosing. i.e. "Fix-Home-Button-#435"
- Hint: you can create a branch easily in GitHub desktop:
- Go ahead and code!
- Whenever you feel like a chunk/stage is done, feel free to make a commit to to your personal branch with some describing info.
- Hint: This is easy in GitHub Desktop; whenever you save; you will see the changes updated in GitHub Desktop. Just fill out some info in the bottom left of the screen and hit
Commit to *YourBranchName*
- This commits the changes locally; but not for the general public to see; to sync these commits for everyone; select
Pushup the top near your branch name
- At this point you probably would want to have reached out and ensured you have been added as a contributor to the project on Github to make the permissions easier to navigate. Jump on Telegram and mention something along the lines of:
I have a PR that i want to submit, can someone add me to the contributors channel and add my GitHub username: *username* to the repo - If you would like to keep your username undoxxed from your Telegram name (this is good practice!) do the same as the above but dont say your username and it can instead be shared privately via PM with one of the other contributors once they reply to you
- Once you feel your branch has sufficiently covered the Github issue you were working on; feel free to make a
Pull Request(dont be afraid; you can't accidentally break anything thats live; the other contributors will have to review and decide whether to merge it before that happens) - Hint: This is easy to do in GitHub Desktop, after you have
Pushed(see above) you are able to finalize your branch and make a request to merge it with another branch (or main/master). Just select create PR near the top - This will pop up GitHub in your browser with some info for you to fill out; this is more important than the commits to fill out with any information/nuances that you want to communicate with the rest of the contributors. This info will be used (along with the list of lines of code changed) for the other contributors to decide whether to merge it or not.
- Keep an eye out for reviews/comments from the other contributors on your PR and more importantly CONGRATS on becoming a Spartan contributor!
- Any and all skill levels welcome!
- https://t.me/SpartanProtocolOrg
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify