luxfi/safe-wallet
1
0
Fork 0
mirror of https://github.com/luxfi/safe-wallet.git synced 2026-07-26 22:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(mobile): move docs to correct locations

Browse Source 
The mobile docs were in the wrong directory (caused by the monorepo move)
This commit is contained in:
daniel-safe
2025-02-12 11:11:47 +00:00
parent 85c41cebd5
commit 1ad4f06758
3 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+8 -6
View File
@@ -1,14 +1,16 @@
# Contributing
### tl;dr
* Pull requests are very welcome
* Check [**good first issues**](https://github.com/safe-global/safe-wallet-monorepo/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) if you want to contribute but don't know what
* We do NOT accept tiny text edits, typo fixes etc, which is typically bot activity/airdrop farming
* Each pull requests is rewarded with a [GitPOAP](https://www.gitpoap.io/gh/safe-global/safe-wallet-monorepo) but this does NOT guarantee any other perks
- Pull requests are very welcome
- Check [**good first issues**](https://github.com/safe-global/safe-wallet-monorepo/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) if you want to contribute but don't know what
- We do NOT accept tiny text edits, typo fixes etc, which is typically bot activity/airdrop farming
- Each pull requests is rewarded with a [GitPOAP](https://www.gitpoap.io/gh/safe-global/safe-wallet-monorepo) but this does NOT guarantee any other perks
## Code Style
More information [here](./docs/code-style.md).
The packages inside the repo try to follow the same code style, but there might be small differences. Check the `code-style.md`
file in the package you are working on for specific guidelines.
We use [semantic commits](https://www.conventionalcommits.org/en/v1.0.0/) for pull request titles and commit messages.
## CLA
@@ -20,7 +22,7 @@ It is a requirement for all contributors to sign the [Contributor License Agreem
- When opening a pull request, please make sure to fully fill out the pull request template that will appear in the description text box.
- Make sure to cover your changes with unit tests.
- Automatic linting and tests should pass once the workflows are approved by a maintainer.
- Please follow our [Code Style Guidelines](docs/code-style.md).
- Please follow our Code Style Guidelines for the package you are working on.
## Code of Conduct
docs/code-style.md → apps/mobile/docs/code-style.md
+7 -7
View File
@@ -26,7 +26,7 @@
### Exporting Components
- **Always prefer named exports over default exports.**
- Named exports make it easier to refactor and identify exports in a codebase.
- Named exports make it easier to refactor and identify exports in a codebase.
### Features and Screens
@@ -59,11 +59,11 @@ For a feature called **Assets**, the file structure might look like this:
- **Presentation Components**:
- Responsible only for rendering the UI.
- Receive data and callbacks via props.
- Avoid direct manipulation of business logic.
- Simple business logic can be included but should generally be extracted into hooks.
- Responsible only for rendering the UI.
- Receive data and callbacks via props.
- Avoid direct manipulation of business logic.
- Simple business logic can be included but should generally be extracted into hooks.
- **Container Components**:
- Handle business logic (e.g., state management, API calls, etc.).
- Pass necessary data and callbacks to the corresponding Presentation component.
- Handle business logic (e.g., state management, API calls, etc.).
- Pass necessary data and callbacks to the corresponding Presentation component.
docs/release-procedure.md → apps/mobile/docs/release-procedure.md
+3 -3
View File
@@ -1,8 +1,8 @@
# Releasing to Production
The code is being actively developed on the `main` branch. Pull requests are made against this branch.
The code is being actively developed on the `dev` branch. Pull requests are made against this branch.
When we want to make a release, we create a new branch from `main` called `mobile-release/vX.Y.Z` where `X.Y.Z` is the
When we want to make a release, we create a new branch from `dev` called `mobile-release/vX.Y.Z` where `X.Y.Z` is the
version number of the release.
This will trigger a new build on the CI/CD pipeline, which will build the app and submit it to the internal distribution
@@ -12,4 +12,4 @@ The release has to be tested by QA and once approved can be promoted to the prod
## Triggering Maestro E2E tests
On the release PR add the github label `eas-build-ios:build-and-maestro-test` to trigger the e2e tests in Expo CI.
Any PR that touches files inside `apps/mobile` or `packages/*` folders will trigger an e2e iOS test.