You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+40-40Lines changed: 40 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ To get started with contributing, follow these steps:
35
35
### Steps
36
36
37
37
1.**Fork the Repository**:
38
-
- Click the "Fork" button on the top right of the repository page to create your own copy.
38
+
- Click the "Fork" button on the top right of the repository page to create your own copy.
39
39
40
40
2.**Clone the Repository**:
41
41
```bash
@@ -44,15 +44,15 @@ To get started with contributing, follow these steps:
44
44
```
45
45
46
46
3.**Open the Project in Android Studio**:
47
-
- Open Android Studio and select "Open an Existing Project."
48
-
- Navigate to the cloned repository and open it.
47
+
- Open Android Studio and select "Open an Existing Project."
48
+
- Navigate to the cloned repository and open it.
49
49
50
50
4.**Install Dependencies**:
51
-
- Sync the project with Gradle to download all dependencies.
51
+
- Sync the project with Gradle to download all dependencies.
52
52
53
53
5.**Run the App**:
54
-
- Connect an Android device or start an emulator.
55
-
- Click the "Run" button in Android Studio to build and run the app.
54
+
- Connect an Android device or start an emulator.
55
+
- Click the "Run" button in Android Studio to build and run the app.
56
56
57
57
---
58
58
@@ -66,9 +66,9 @@ If you find a bug, please open an issue and include the following information:
66
66
-**Actual Behavior**: What actually happened.
67
67
-**Screenshots**: If applicable, add screenshots to help explain the issue.
68
68
-**Device Information**:
69
-
- Device model
70
-
- Android version
71
-
- App version
69
+
- Device model
70
+
- Android version
71
+
- App version
72
72
73
73
**Example**:
74
74
@@ -120,34 +120,34 @@ If you have an idea for a new feature or improvement, please open an issue and i
120
120
If you'd like to contribute code, follow these steps:
121
121
122
122
### 1. Create a Branch
123
-
- Create a new branch for your feature or bug fix:
124
-
```bash
125
-
git checkout -b feature/your-feature-name
126
-
```
123
+
- Create a new branch for your feature or bug fix:
124
+
```bash
125
+
git checkout -b feature/your-feature-name
126
+
```
127
127
128
128
### 2. Make Your Changes
129
-
- Write your code and ensure it follows the project's coding standards (see below).
129
+
- Write your code and ensure it follows the project's coding standards (see below).
130
130
131
131
### 3. Test Your Changes
132
-
- Run the app and ensure your changes work as expected.
133
-
- Write unit tests if applicable.
132
+
- Run the app and ensure your changes work as expected.
133
+
- Write unit tests if applicable.
134
134
135
135
### 4. Commit Your Changes
136
-
- Write clear and concise commit messages:
137
-
```bash
138
-
git commit -m "Add dark mode feature"
139
-
```
136
+
- Write clear and concise commit messages:
137
+
```bash
138
+
git commit -m "Add dark mode feature"
139
+
```
140
140
141
141
### 5. Push Your Changes
142
-
- Push your branch to your forked repository:
143
-
```bash
144
-
git push origin feature/your-feature-name
145
-
```
142
+
- Push your branch to your forked repository:
143
+
```bash
144
+
git push origin feature/your-feature-name
145
+
```
146
146
147
147
### 6. Open a Pull Request
148
-
- Go to the original repository and click "New Pull Request."
149
-
- Provide a clear title and description for your pull request.
150
-
- Reference any related issues (e.g., "Fixes #123").
148
+
- Go to the original repository and click "New Pull Request."
149
+
- Provide a clear title and description for your pull request.
150
+
- Reference any related issues (e.g., "Fixes #123").
151
151
152
152
---
153
153
@@ -156,15 +156,15 @@ If you'd like to contribute code, follow these steps:
156
156
To maintain consistency, please follow these coding standards:
157
157
158
158
-**Java**:
159
-
- Use 4 spaces for indentation.
160
-
- Follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).
159
+
- Use 4 spaces for indentation.
160
+
- Follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).
161
161
-**XML**:
162
-
- Use 2 spaces for indentation.
163
-
- Use descriptive IDs and names for resources.
162
+
- Use 2 spaces for indentation.
163
+
- Use descriptive IDs and names for resources.
164
164
-**Commit Messages**:
165
-
- Use the present tense (e.g., "Add feature" instead of "Added feature").
166
-
- Keep the first line under 50 characters.
167
-
- Provide a detailed description if necessary.
165
+
- Use the present tense (e.g., "Add feature" instead of "Added feature").
166
+
- Keep the first line under 50 characters.
167
+
- Provide a detailed description if necessary.
168
168
169
169
---
170
170
@@ -181,20 +181,20 @@ Before submitting your changes, ensure the app works as expected:
181
181
## Code Review Process
182
182
183
183
1.**Pull Request Submission**:
184
-
- Open a pull request with a clear description of your changes.
185
-
- Ensure your code passes all tests and follows the coding standards.
184
+
- Open a pull request with a clear description of your changes.
185
+
- Ensure your code passes all tests and follows the coding standards.
186
186
187
187
2.**Review**:
188
-
- A maintainer will review your pull request and provide feedback.
189
-
- Be prepared to make changes based on the feedback.
188
+
- A maintainer will review your pull request and provide feedback.
189
+
- Be prepared to make changes based on the feedback.
190
190
191
191
3.**Merge**:
192
-
- Once approved, your pull request will be merged into the main branch.
192
+
- Once approved, your pull request will be merged into the main branch.
193
193
194
194
---
195
195
196
196
## Thank You!
197
197
198
198
We appreciate your contributions and look forward to working with you. If you have any questions, feel free to open an issue or reach out to the maintainers.
0 commit comments