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
Thank you for considering contributing to our Android Jetpack Compose Library project. Your contributions help make this project better for everyone.
3
+
Thank you for considering contributing to our Android Jetpack Compose Library
4
+
project. Your contributions help make this project better for everyone.
4
5
5
6
## Table of Contents
7
+
6
8
1.[Code of Conduct](#code-of-conduct)
7
9
2.[How to Contribute](#how-to-contribute)
8
10
3.[Reporting Issues](#reporting-issues)
@@ -15,138 +17,178 @@ Thank you for considering contributing to our Android Jetpack Compose Library pr
15
17
10.[Creating ADRs](#creating-adrs)
16
18
17
19
## Code of Conduct
18
-
This project adheres to a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report any unacceptable behavior to [[email protected]](mailto:[email protected]).
20
+
21
+
This project adheres to a [Code of Conduct](./CODE_OF_CONDUCT.md). By
22
+
participating, you are expected to uphold this code. Please report any
If you find a bug or have a feature request, please open an issue in the [issue tracker](https://github.com/your-repo/compose-library/issues). Be sure to include:
23
-
- A descriptive title.
24
-
- A detailed explanation of the issue or request.
25
-
- Steps to reproduce the issue (if applicable).
26
-
- Any relevant screenshots or logs.
29
+
30
+
If you find a bug or have a feature request, please open an issue in
31
+
the [issue tracker](https://github.com/your-repo/compose-library/issues). Be
32
+
sure to include:
33
+
34
+
* A descriptive title.
35
+
* A detailed explanation of the issue or request.
36
+
* Steps to reproduce the issue (if applicable).
37
+
* Any relevant screenshots or logs.
27
38
28
39
### Pull Requests
29
-
We welcome your pull requests! To ensure a smooth process, please follow these steps:
40
+
41
+
We welcome your pull requests! To ensure a smooth process, please follow these
42
+
steps:
30
43
31
44
1.**Fork the Repository:**
32
-
- Create your own copy of the repository by clicking the `Fork` button on GitHub.
45
+
* Create your own copy of the repository by clicking the `Fork` button on
- File > Open... and select the cloned repository folder.
81
+
* Open the project folder in Android Studio:
82
+
* File > Open... and select the cloned repository folder.
67
83
68
84
4.**Sync Project with Gradle Files:**
69
-
- Android Studio should automatically resolve and fetch dependencies when you open the project.
85
+
* Android Studio should automatically resolve and fetch dependencies when
86
+
you open the project.
70
87
71
88
5.**Run Tests:**
72
-
- Ensure all tests pass by selecting `Run > Run...` and choosing the test configuration.
89
+
* Ensure all tests pass by selecting `Run > Run...` and choosing the test
90
+
configuration.
73
91
74
92
## Coding Standards
93
+
75
94
Please adhere to the following coding standards to ensure consistency:
76
95
77
-
- Follow the Kotlin Coding Conventions.
78
-
- Follow Markdown and YAML style guides:
79
-
- Markdown: Follow the [Markdown Guide](https://www.markdownguide.org/basic-syntax/).
80
-
- YAML: Adhere to typical YAML syntax and style rules.
96
+
* Follow the Kotlin Coding Conventions.
97
+
* Follow Markdown and YAML style guides:
98
+
* Markdown: Follow
99
+
the [Markdown Guide](https://www.markdownguide.org/basic-syntax/).
100
+
* YAML: Adhere to typical YAML syntax and style rules.
81
101
82
102
## Code Quality
83
-
To maintain high code quality, we use the following linters and tools in our CI/CD pipeline. Please ensure your code adheres to these standards before submitting a pull request:
103
+
104
+
To maintain high code quality, we use the following linters and tools in our
105
+
CI/CD pipeline. Please ensure your code adheres to these standards before
106
+
submitting a pull request:
84
107
85
108
1.**Android Lint:**
86
-
- Android Lint checks the code for potential bugs, stylistic errors, and other issues.
87
-
- You can run Android Lint manually using the following command:
88
-
```sh
89
-
./gradlew lint
90
-
```
109
+
* Android Lint checks the code for potential bugs, stylistic errors, and
110
+
other issues.
111
+
* You can run Android Lint manually using the following command:
112
+
113
+
```sh
114
+
./gradlew lint
115
+
```
91
116
92
117
2. **Markdown Lint:**
93
-
- Linting for Markdown can be done using `markdownlint-cli`:
94
-
```sh
95
-
npm install -g markdownlint-cli
96
-
markdownlint '**/*.md'
97
-
```
118
+
* Linting for Markdown can be done using `markdownlint-cli`:
119
+
120
+
```sh
121
+
npm install -g markdownlint-cli
122
+
markdownlint '**/*.md'
123
+
```
98
124
99
125
3. **YAML Lint:**
100
-
- Linting for YAML files can be done using `yamllint`:
101
-
```sh
102
-
brew install yamllint
103
-
yamllint .
104
-
```
126
+
* Linting for YAML files can be done using `yamllint`:
127
+
128
+
```sh
129
+
brew install yamllint
130
+
yamllint .
131
+
```
105
132
106
133
### CI/CD Integration
107
-
Our CI/CD pipeline will automatically run these linters on every pull request to ensure code quality. Here is a summary of the checks performed:
108
134
109
-
- **Android Lint:** Ensures Android code adheres to style and quality guidelines.
110
-
- **Markdown Lint:** Checks Markdown files for style and syntax correctness.
111
-
- **YAML Lint:** Checks YAML files for syntax errors and style issues.
135
+
Our CI/CD pipeline will automatically run these linters on every pull request to
136
+
ensure code quality. Here is a summary of the checks performed:
137
+
138
+
***Android Lint:** Ensures Android code adheres to style and quality
139
+
guidelines.
140
+
***Markdown Lint:** Checks Markdown files for style and syntax correctness.
141
+
***YAML Lint:** Checks YAML files for syntax errors and style issues.
112
142
113
143
Make sure your code passes these checks before opening a pull request.
114
144
115
145
## Documentation
146
+
116
147
Good documentation helps others understand your code. Please:
117
148
118
-
- Update the `DEVELOPMENT.md` file if your changes affect the development process.
119
-
- Ensure your code is well-commented, especially for complex logic.
120
-
- Update or create relevant ADRs in the `docs/adr` directory.
149
+
* Update the `DEVELOPMENT.md` file if your changes affect the development
150
+
process.
151
+
* Ensure your code is well-commented, especially for complex logic.
152
+
* Update or create relevant ADRs in the `docs/adr` directory.
121
153
122
154
## Running Tests
155
+
123
156
To run the test suite:
124
157
125
158
1. **Open the Project in Android Studio:**
126
-
- Open the project folder in Android Studio.
159
+
* Open the project folder in Android Studio.
127
160
128
161
2. **Run Tests:**
129
-
- Run the test suite by selecting `Run > Run Tests` or by using the command:
130
-
```sh
131
-
./gradlew testDebugUnitTest
132
-
./gradlew connectedAndroidTest
133
-
```
162
+
* Run the test suite by selecting `Run > Run Tests` or by using the command:
163
+
164
+
```sh
165
+
./gradlew testDebugUnitTest
166
+
./gradlew connectedAndroidTest
167
+
```
134
168
135
169
Ensure that all tests pass before submitting your pull request.
136
170
137
171
## Creating ADRs
138
-
Architecture Decision Records (ADRs) document significant architectural decisions made during the project. When you need to record an architectural decision, follow these steps:
172
+
173
+
Architecture Decision Records (ADRs) document significant architectural
174
+
decisions made during the project. When you need to record an architectural
175
+
decision, follow these steps:
139
176
140
177
1. **Create an ADR Document:**
141
-
- ADRs should be created in the `docs/adr` directory.
142
-
- Use the template provided in`docs/adr-xx-Template.md`.
178
+
* ADRs should be created in the `docs/adr` directory.
179
+
* Use the template provided in`docs/adr-xx-Template.md`.
143
180
144
181
2. **Document the Decision:**
145
-
- Follow the structure in the template.
182
+
* Follow the structure in the template.
146
183
147
184
3. **Review and Approval:**
148
-
- Submit the ADR for review by creating a pull request.
149
-
- The ADR must be approved by the Maintainers/Codeowners before it is merged. This ensures that all architectural decisions are aligned with the project's overall strategy.
185
+
* Submit the ADR for review by creating a pull request.
186
+
* The ADR must be approved by the Maintainers/Codeowners before it is
187
+
merged. This ensures that all architectural decisions are aligned with the
188
+
project's overall strategy.
189
+
190
+
## Thank You
150
191
151
-
## Thank You!
152
-
Thank you for contributing to the Android Jetpack Compose Library project. Your efforts help improve the project for everyone. We appreciate your time and dedication!
192
+
Thank you for contributing to the Android Jetpack Compose Library project. Your
193
+
efforts help improve the project for everyone. We appreciate your time and
0 commit comments