How to ContributeFollow this for each task:
- Move your Asana task to
In Progresscolumn on the project board - Create a new branch named
A-[id of Asana task]- E.g.:
git checkout dev git checkout -b A-1202012043191654 - Do as many commits as you need.
- Push the branch to the remote repo:
- E.g.:
git push origin A-1202012043191654 - Create your PR setting a title like
A-[id of Asana task]: [short description]:- E.g.:
A-1202012043191654: Update README with branches info
- E.g.:
- Always set base branch to
dev - Set some relevant reviewers to your PR
- Check if you've completed all the items on the PR's template checklist
- Move your Asana task to
Ready for Code Reviewcolumn on the project board - After getting the approval of all of the selected reviewers, merge your branch with
Squash and merge - Remove your branch after merging
- Move your asana task to
Ready do be deployed
This part is meant to describe how the project is structured. So if you are creating a new feature or fixing something, you should follow this organization.
You can see a visual representation of the file structure here.
Main directory for React components.
Each Component should be on its own folder with its own tests and CSS files.
Everything should have visual tests in this folder. Unit tests can be done if needed
🚫 Do not use inside components 🚫
- Redirects to other routes.
Servicedependencies like:- @APIs
- @Databases
- @Cryptos
- @Entities
Only visual components which use only simple HTML elements should be here.
Components here should be generic. No specific logic or properties should be in these components.
Visual components which are made of other components, with or without extra HTML elements.
Components here should be generic. No specific logic or properties should be in these components.
Visual components which are made just for visual structure purposes
Components here should be generic. No specific logic or properties should be in these components.
Visual components used by a specific Page. They could be build out of Basic and/or Composed, with or without extra HTML elements.
Also, here it is allowed to have specific logic and properties.
Project's custom hooks.
Each Hook should be on its own folder with its own tests file.
Everything should have a unit test here.
Projects custom contexts.
Each Context should be on its own folder with its own tests file.
Everything should have a unit test here.
Common styles and CSS variables that will affect or be used throught the whole app.
Common image that be used throught the whole app.
Not visual dependencies should be in this directory.
Connections to external services should be in this directory.
Ex.: Coinlayer.com, Electrum server...
Each external service should be on its own folder with its own test file.
Connections to databases should be in this directory.
Ex.: IndexedDB, LocalStorage...
Each database Service should be on its own folder with its own test file. If a WebWorker is needed should be in its own folder as well.
Blockchain token and encryption functions should be in this directory.
Ex.: BTC, ML, ETH, AES, PBKDF2...
Each crypto Service should be on its own folder with its own test file. If a WebWorker is needed it should be in this folder as well.
Entities that are saved in the app should be in this directory.
Ex.: Account.
Each entity Service should be on its own folder with its own test file. If a WebWorker, or WebWorkers consumer, is needed it should be in this folder as well.
Every page, related to a route in src/index.js, should be here.
The components used here should be imported just from its own Container folder.
Any Service should be used just here. If a Component needs something from the service, it should be passed from here as prop.
Redirects to other routes should be here.
Each page should be on its own folder with its own CSS file.
Pages should be tested with E2E tests. E2E tests should be written accordingly to the related User Story(ies).