Skip to content
This repository was archived by the owner on Jul 25, 2024. It is now read-only.

Commit 091e113

Browse files
jainkuniyatimabbott
authored andcommitted
github: Added Templates for Issue and Pull Requests.
Edited by tabbott for clearer professional English. Fixes #313.
1 parent c2d4fca commit 091e113

File tree

4 files changed

+86
-0
lines changed

4 files changed

+86
-0
lines changed

.github/ISSUES_GUIDE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
**Writing good bug reports**
2+
3+
- Include `LogCat` output for crashes.
4+
5+
- Include a screenshot for UI/display issues.
6+
7+
- Include device info (model number, Android version etc) if it could
8+
be relevant.
9+
10+
- Provide steps to reproduce if you know how to reproduce the issue.
11+
12+
- Read more details on good bug reporting practices at
13+
https://guides.github.com/features/issues/.

.github/ISSUE_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[Read our guide on bug reports here](./ISSUES_GUIDE.md)
2+
3+
**Actual Behaviour**
4+
5+
Explain what is currently happening.
6+
7+
**Expected Behaviour**
8+
9+
Explain what you expected (unnecessary if it's obviouxly broken, e.g. a crash).
10+
11+
**Would you like to work on the issue?**
12+
13+
Let us know if this issue should be assigned to you.

.github/PULL_REQUEST_GUIDE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
**Auto-formatting code**
2+
3+
The Zulip Android app uses auto-formatted code. In Android Studio,
4+
you can auto-format code as follows:
5+
6+
* Mac: `Option + Command + L`
7+
* Windows: `Ctrl + Alt + L`
8+
* Linux: Go to `File->Settings->(under IDE settings)->Keymap` and
9+
change the shortcut as `Ctrl + Alt + L` locks the screen on linux.
10+
11+
**Lint issues**
12+
13+
- Run the lint tests with `./gradlew lintDebug`.
14+
15+
- It ensure that code has no structural problems. Poorly structured
16+
code can impact the reliability and efficiency of Android apps and
17+
make code harder to maintain. For example, if XML resource files
18+
contain unused namespaces, this takes up space and incurs
19+
unnecessary processing. Other structural issues, such as use of
20+
deprecated elements or API calls that are not supported by the
21+
target API versions, might lead to code failing to run correctly.
22+
23+
- If lint fails, check the report at
24+
`zulip-android/app/build/outputs/lint-results-debug.html` or
25+
`zulip-android/app/build/outputs/lint-results-debug.xml`
26+
27+
**Night Mode**
28+
29+
zulip-android contains a theme for night, so if new UI is designed or
30+
UI is altered, please test to make sure that it is looks good with the
31+
Night theme too.
32+
33+
**Commit messages**
34+
35+
- Usually starts with capital letter, and ends with a period.
36+
37+
- Include `Fixes: #{issue-number}` as a sentence at the end of the
38+
commit message, so that issue is automatically closed when the
39+
commits are merged.
40+
41+
- Read the Zulip project's detailed guide to writing good commits here:
42+
https://zulip.readthedocs.io/en/latest/version-control.html#commit-messages

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
**Summary of changes**
2+
3+
[Explain here what changes were made and why.]
4+
5+
Screenshots or a brief video showing the change in action:
6+
7+
8+
Please make sure these boxes are checked before submitting your pull request - thanks! [Guide](./PULL_REQUEST_GUIDE.md)
9+
10+
- [ ] Code is formatted.
11+
12+
- [ ] Run the lint tests with `./gradlew lintDebug` and make sure BUILD is SUCCESSFUL
13+
14+
- [ ] If new feature is implemeted then it is compatible with Night theme too.
15+
16+
- [ ] Used `Zlog.logException(e)` instead of `e.printStackTrace()`
17+
18+
- [ ] Commit messages are well-written.

0 commit comments

Comments
 (0)