|
3 | 3 | Thank you for your interest in contributing to **PrivacyFirst**! |
4 | 4 |
|
5 | 5 | ## Before You Start |
6 | | -- PrivacyFirst is currently a **private project**. |
7 | | -- Contributions are reviewed and accepted manually by the repository owner. |
| 6 | + |
| 7 | +* PrivacyFirst is currently a **private project**. |
| 8 | +* All contributions are reviewed and accepted manually by the repository owner. |
8 | 9 |
|
9 | 10 | ## Ways to Contribute |
10 | | -- Reporting a bug |
11 | | -- Suggesting a feature |
12 | | -- Improving documentation |
13 | | -- Submitting pull requests (PRs) |
| 11 | + |
| 12 | +* Reporting bugs |
| 13 | +* Suggesting new features |
| 14 | +* Improving documentation |
| 15 | +* Submitting pull requests (PRs) |
14 | 16 |
|
15 | 17 | ## Pull Requests |
16 | | -1. Fork the repository |
17 | | -2. Create a feature branch: |
| 18 | + |
| 19 | +1. **Fork** the repository. |
| 20 | +2. **Create a feature branch:** |
| 21 | + |
| 22 | + ```bash |
| 23 | + git checkout -b feature/my-feature |
| 24 | + ``` |
| 25 | +3. **Commit** using clear, conventional messages such as: |
| 26 | + |
| 27 | + ``` |
| 28 | + feat: add biometric authentication improvements |
| 29 | + fix: resolve crash in WebView SSL handler |
| 30 | + ``` |
| 31 | +4. **Submit a PR** including: |
| 32 | + |
| 33 | + * A clear description of the changes |
| 34 | + * A linked issue (if applicable) |
| 35 | + |
| 36 | +## Code Style |
| 37 | + |
| 38 | +* Follow standard **Kotlin coding conventions** |
| 39 | +* Use **Jetpack Compose** and **MVVM architecture** |
| 40 | +* Document all **security-related changes** thoroughly |
| 41 | + |
| 42 | +## Testing |
| 43 | + |
| 44 | +* Test on real devices whenever possible |
| 45 | +* Ensure the API server is functioning before submitting backend-related changes |
| 46 | + |
| 47 | +## Questions? |
| 48 | + |
| 49 | +Open an issue or contact the maintainer. |
| 50 | + |
| 51 | +--- |
0 commit comments