Ilyas Hallak
07384215eb
- Add CHANGELOG.md, CODE_OF_CONDUCT.md, and Contribute.md for documentation and community standards - Add tools/add_spdx_header.sh for SPDX license header management - Refactor BookmarksView and BookmarksViewModel to support dependency injection via UseCaseFactory - Add retroactive extension for String: Identifiable in StringExtension.swift - Update MockUseCaseFactory and MockGetBookmarksUseCase to provide mock data for previews and tests - Update README.md: add TestFlight info, changelog link, HTTPS/local network note, and move planned features to changelog
60 lines
2.1 KiB
Markdown
60 lines
2.1 KiB
Markdown
# Contributing to Readeck (iOS)
|
||
|
||
Welcome! Thank you for your interest in contributing to the iOS app for Readeck. There are many ways you can help, whether through code, testing, feedback, or documentation.
|
||
|
||
**Please make sure to read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.**
|
||
|
||
## How to Contribute
|
||
|
||
### 1. Report Issues
|
||
|
||
If you find a bug or experience a problem with the iOS app, please open an issue in the repository. Describe the issue as clearly as possible and include screenshots or crash logs if available.
|
||
|
||
### 2. Suggest Features
|
||
|
||
Have an idea for a new feature or improvement? Open a feature request issue and describe your idea. You are also welcome to discuss ideas in the forum or the Matrix chat (#readeck:matrix.org) or contact me directly: mooonki:matrix.org.
|
||
|
||
### 3. Contribute Code
|
||
|
||
Pull requests are welcome! Here’s how to get started:
|
||
|
||
1. Fork the repository and clone it locally.
|
||
2. Set up your development environment (see below).
|
||
3. Create a new branch for your changes.
|
||
4. Write clean, well-documented code and follow the existing coding standards.
|
||
5. Test your changes (unit and UI tests).
|
||
6. Open a pull request and describe your changes.
|
||
|
||
### 4. Translations
|
||
|
||
Help translate the iOS app! If you want to add or improve a language, edit the `Localizable.xcstrings` file and submit a pull request.
|
||
|
||
### 5. Improve Documentation
|
||
|
||
Help improve the README.md, Contribute.md, or other documentation. Good documentation benefits everyone!
|
||
|
||
## Setting Up the Development Environment
|
||
|
||
1. Install Xcode (latest version recommended).
|
||
2. Clone the repository:
|
||
```
|
||
git clone https://codeberg.org/readeck/readeck-ios.git
|
||
```
|
||
3. Install dependencies (if any, e.g., Swift Packages).
|
||
4. Open the project in Xcode: `readeck.xcodeproj`
|
||
5. Build and run on a simulator or device.
|
||
|
||
## Community & Support
|
||
|
||
- Forum: [Readeck Forum](https://readeck.org/forum)
|
||
- Matrix: #readeck:matrix.org
|
||
- Issues: In the respective repository on Codeberg or Github
|
||
|
||
## Code of Conduct
|
||
|
||
Please follow the [Code of Conduct](https://readeck.org/en/contribute) and be respectful in all interactions.
|
||
|
||
---
|
||
|
||
Thank you for helping make Readeck better!
|