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
{{ message }}
Repository navigation
Commit 83c243e
Browse filesBrowse the repository at this point in the historyBrowse files
* Added ADFA logo as PNG 512x512 To replace AndroidIDE logo in the readme and possibly other files
* Update CODE_OF_CONDUCT.md with our email
* Update README.md
* Update CONTRIBUTING.md
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+37-22Lines changed: 37 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,30 @@ agree to abide the terms specified in the [CODE OF CONDUCT](./CODE_OF_CONDUCT.md
6
6
## Requirements
7
7
8
8
- Android Studio.
9
-
- JDK 17 (prefer the one bundled with Android Studio).
9
+
- JDK 17
10
10
11
-
> NOTE:
12
-
>
13
-
> At the time of this writing, the stable version of Android Studio (Electric Eel) is bundled with
14
-
> JDK 11. Only Android Studio Flamingo and newer are bundled with JDK 17.
11
+
## Git Pre-Commit Hook: Branch Name Enforcement
15
12
16
-
## Build the project
13
+
This project enforces a strict branch naming policy using a Git pre-commit hook.
17
14
18
-
Open the project in Android Studio. No extra steps are needed for this.
15
+
### Allowed Branch Formats:
16
+
-`ADFA-123` (3 to 5 digit number)
17
+
-`feature/ADFA-123`
18
+
-`bugfix/ADFA-12345`
19
+
-`chore/ADFA-9999`
20
+
-`anyprefix/ADFA-#####`
19
21
20
-
It is possible to build AndroidIDE in AndroidIDE itself. But, as it might be a too heavy task for an
21
-
Android device to be able to build the project, Android Studio is always recommended.
22
+
### Setup
22
23
23
-
You can refer the [AndroidIDE Developer Guide](https://docs.androidide.com/developer/index.html) to
24
-
get started with the development or to learn more about the various components in the IDE.
24
+
#### Mac/Linux:
25
+
```bash
26
+
sh ./scripts/install-git-hooks.sh
27
+
```
25
28
29
+
#### Windows
30
+
```bash
31
+
scripts\install-git-hooks.bat
32
+
```
26
33
## Source code format
27
34
28
35
- Indents : 2-space
@@ -37,10 +44,9 @@ get started with the development or to learn more about the various components i
37
44
38
45
## Propose a change
39
46
40
-
Before proposing a change, it is always recommended to open an issue and discuss it with the
41
-
maintainers.
47
+
Before proposing a change, please open an issue and discuss it with our team.
42
48
43
-
**The `main` branch is protected and requires all the commits to be signed with your GPG key and the
49
+
**The `dev` branch is protected and requires all commits to be signed with your GPG key and the
44
50
commit history to be linear.**
45
51
See [protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)
46
52
.
@@ -51,16 +57,25 @@ To contribute to this project,
51
57
- Clone the forked repo to your local machine.
52
58
- Open the project.
53
59
- Make your changes.
54
-
- Create a pull request. Give a proper title and description to your PR.
60
+
- Create a pull request that includes a meaningful title and description.
55
61
56
-
## Issues & Pull requests
62
+
## Report issues
57
63
58
-
Use the issue/PR templates whenever possible. Provide a proper title and a clear description of the
59
-
issue/PR. For bug reports, provide a step-by-step procedure to reproduce the issue. Always put
60
-
things like crash
61
-
logs, and build outputs in `code blocks`.
64
+
[Report issues and request features here](https://github.com/appdevforall/CodeOnTheGo/issues).
62
65
63
66
## Contact us
64
67
65
-
If you want to discuss anything about the project, you can discuss it in
66
-
the [Telegram group](https://t.me/androidide_discussions).
<ahref="https://github.com/AndroidIDEOfficial/AndroidIDE/issues/new?labels=bug&template=BUG.yml&title=%5BBug%5D%3A+">Report a bug</a> •
28
-
<ahref="https://github.com/AndroidIDEOfficial/AndroidIDE/issues/new?labels=feature&template=FEATURE.yml&title=%5BFeature%5D%3A+">Request a feature</a> •
29
-
<ahref="https://t.me/androidide_discussions">Join us on Telegram</a>
30
-
</p>
31
-
32
-
> **We are looking for contributors/maintainers to help keep the project alive and speed up the development. You can help by fixing bugs, implementing & improving features, writing documentation, etc.**
- Download the Code On The Go APK from the mentioned trusted sources.
97
-
- Follow the
98
-
instructions [here](https://docs.androidide.com/tutorials/get-started.html) to
99
-
install the build tools.
22
+
<ahref="https://www.appdevforall.org/codeonthego">Download the Code On The Go APK from the App Dev for All website.</a>
100
23
101
24
## Limitations
102
25
103
-
- For working with projects in Code On The Go, your project must use Android Gradle Plugin v7.2.0 or
104
-
newer. Projects with older AGP must be migrated to newer versions.
105
-
- SDK Manager is already included in Android SDK and is accessible in Code On The Go via its Terminal.
106
-
But, you cannot use it to install some tools (like NDK) because those tools are not built for
107
-
Android.
108
-
- No official NDK support because we haven't built the NDK for Android.
109
-
110
-
The app is still being developed actively. It's in beta stage and may not be stable. if you have any
111
-
issues using the app, please let us know.
26
+
<p>This is an early, experimental version of Code on the Go, our offline-first Android IDE. This release is intended for Android developers who are comfortable testing rough software and providing constructive feedback. Please note:
27
+
<ul><li>Some features are incomplete or missing
28
+
<li>Stability may vary across devices
29
+
<li>UI and interactions are provisional
30
+
</li></ul></p>
112
31
113
32
## Contributing
114
33
115
34
See the [contributing guide](./CONTRIBUTING.md).
116
35
117
-
For translations, visit the [Crowdin project page](https://crowdin.com/project/androidide).
The following PDF is redistributed under the Creative Commons Attribution 4.0 International License (CC BY 4.0):
61
+
- Java, Java, Java: Object-Oriented Problem Solving, Third Edition by R. Morelli and R. Walde, previously published by Pearson Education, Inc. (Source: https://open.umn.edu/opentextbooks/textbooks/java-java-java-object-oriented-problem-solving)
62
+
63
+
### Free books from Goalkicker.com
64
+
- Android Notes for Professionals (Source: https://goalkicker.com/AndroidBook/)
65
+
- Java Notes for Professionals (Source: https://goalkicker.com/JavaBook/)
66
+
- Kotlin Notes for Professionals (Source: https://goalkicker.com/KotlinBook/)
67
+
68
+
### Third-Party Documentation
69
+
This project includes unmodified documentation from:
0 commit comments