Create CONTRIBUTING.md

2026-05-18 09:30:35 +00:00 · 2026-01-22 15:15:10 +05:45
parent 6792acc685
commit 6ae45bc6cc
1 changed files with 64 additions and 0 deletions
@@ -0,0 +1,64 @@
+# Contributing to Torrent Search
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. If you do know how to code and want to contribute see below and if you like the project but don't know how to code, you can support the project in other easy ways:
+
+- Star the project
+- Help to translate to other languages
+- Report bugs
+- Suggest new features or enhancements
+
+  
+## Setting up the project
+
+### Prerequisites
+
+- **Android Studio**: Install the latest version of Android Studio. You can download it from [here](https://developer.android.com/studio).
+- **Git**: Install Git to clone and manage the repository.
+
+### Steps
+
+1. **Fork the repository**
+   - Click the `Fork` button on the top right of the repository page to create your own copy.
+2. **Clone the forked repository**
+   ```shell
+   git clone https://github.com/<your-username>/TorrentSearch
+   cd TorrentSearch
+   ```
+3. **Open the project in Android Studio**
+   - Open Android Studio and click `Open an Existing Project`.
+   - Navigate to the cloned repository and open it.
+   - Wait for sync to finish.
+4. **Run the app**
+   - Connect an Android device or start an emulator.
+   - Click the play button on the top right in Android Studio to build and run the app.
+  
+### Development guidelines
+
+#### Code styles
+
+- Follow [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html)
+- Use Android Studio's default formatting (Ctrl+Alt+L).
+- Use meaningful name for variable, function, class, object, and so on.
+- Use newline to group related code snippet.
+- Group releated imports and remove unused ones.
+
+### Commit message style
+
+Use [Conventional Commits](https://www.conventionalcommits.org/) format as much as possible:
+
+```
+<type>: <description>
+```
+
+Common types: `feat`, `fix`, `refactor`, `chore`.
+
+### Creating pull request
+
+- Once you commit your changes, push your branch to your forked repository.
+- Open your forked repository and click `Contribute > Open pull request`.
+- Provide a clear title and description for your pull request.
+- Reference any related issues (e.g., "Fixes #123").
+
+Thank you for contributing to Torrent Search! 🚀