mirror of
https://github.com/permissionlesstech/bitchat-android.git
synced 2026-07-24 22:45:20 +00:00
Merge pull request #25 from HarshPanchal18/main
Provided ISSUE and PR TEMPLATES
This commit is contained in:
@@ -0,0 +1,30 @@
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value:
|
||||
"Thanks for taking the time to fill out this form! :hugs:"
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: "Checklist"
|
||||
options:
|
||||
- label: "I made sure that there are *no existing issues or discussions* - [open](https://github.com/callebtc/bitchat-android/issues) or [closed](https://github.com/callebtc/bitchat-android/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
|
||||
required: true
|
||||
- label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
|
||||
required: true
|
||||
- label: "I have read and understood the [technical architecture](https://github.com/callebtc/bitchat-android/blob/main/README.md#technical-architecture)."
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-is-the-question
|
||||
attributes:
|
||||
label: What is/are your question(s)?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-information
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: Any other information you'd like to include, for instance sketches, mockups, pictures of cats, etc.
|
||||
@@ -0,0 +1,102 @@
|
||||
name: Bug report
|
||||
description: Create a bug report to help us improve
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for helping to make Bitchat better by reporting a bug. :hugs:
|
||||
|
||||
Please fill in as much information as possible about your bug so that we don't have to play "information ping-pong" and can help you immediately.
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: "Checklist"
|
||||
options:
|
||||
- label: "I am able to reproduce the bug with the latest version given here: [CLICK THIS LINK](https://github.com/callebtc/bitchat-android/releases/latest)."
|
||||
required: true
|
||||
- label: "I made sure that there are *no existing issues* - [open](https://github.com/callebtc/bitchat-android/issues) or [closed](https://github.com/callebtc/bitchat-android/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
|
||||
required: true
|
||||
- label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
|
||||
required: true
|
||||
- label: "This issue contains only one bug."
|
||||
required: true
|
||||
- label: "I have read and understood the [contribution guidelines](https://github.com/callebtc/bitchat-android/blob/main/README.md#contributing)."
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: app-version
|
||||
attributes:
|
||||
label: Affected version
|
||||
description: "In which bitchat version did you encounter the bug?"
|
||||
placeholder: "x.xx.x - Can be seen in the `release` section of the repository."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps-to-reproduce
|
||||
attributes:
|
||||
label: Steps to reproduce the bug
|
||||
description: |
|
||||
What did you do for the bug to show up?
|
||||
|
||||
If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug.
|
||||
placeholder: |
|
||||
1. Go to '...'
|
||||
2. Press on '....'
|
||||
3. Swipe down to '....'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: |
|
||||
Tell us what you expect to happen.
|
||||
|
||||
- type: textarea
|
||||
id: actual-behavior
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: |
|
||||
Tell us what happens with the steps given above.
|
||||
|
||||
- type: textarea
|
||||
id: screen-media
|
||||
attributes:
|
||||
label: Screenshots/Screen recordings
|
||||
description: |
|
||||
A picture or video is worth a thousand words.
|
||||
|
||||
If applicable, add screenshots or a screen recording to help explain your problem.
|
||||
GitHub supports uploading them directly in the text box.
|
||||
If your file is too big for Github to accept, try to compress it (ZIP-file) or feel free to paste a link to an image/video hoster here instead.
|
||||
|
||||
- type: input
|
||||
id: device-os-info
|
||||
attributes:
|
||||
label: Affected Android/Custom ROM version
|
||||
description: |
|
||||
With what operating system (+ version) did you encounter the bug?
|
||||
placeholder: "Example: Android 14"
|
||||
|
||||
- type: input
|
||||
id: device-model-info
|
||||
attributes:
|
||||
label: Affected device model
|
||||
description: |
|
||||
On what device did you encounter the bug?
|
||||
placeholder: "Example: Samsung Galaxy S20 / Google Pixel 8"
|
||||
|
||||
- type: textarea
|
||||
id: additional-information
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: |
|
||||
Any other information you'd like to include, for instance that
|
||||
* the affected device is foldable or a TV
|
||||
* you have disabled all animations on your device
|
||||
* your cat disabled your network connection
|
||||
* ...
|
||||
@@ -0,0 +1,40 @@
|
||||
name: Feature request
|
||||
description: Request a new feature or enhancement
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: I have used the search function for [**OPEN**](https://github.com/callebtc/bitchat-android/issues) issues to see if someone else has already submitted the same feature request.
|
||||
required: true
|
||||
- label: I have **also** used the search function for [**CLOSED**](https://github.com/callebtc/bitchat-android/issues?q=is%3Aissue+is%3Aclosed) issues to see if the feature was already implemented and is just waiting to be released, or if the feature was rejected.
|
||||
required: true
|
||||
- label: I will describe the problem with as much detail as possible.
|
||||
required: true
|
||||
- label: This request contains only one single feature, **not** a list of multiple (related) features.
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: App version
|
||||
description: The latest version is different on each device, so we need the actual version number found on the settings screen.
|
||||
placeholder: x.y.z
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: feature
|
||||
attributes:
|
||||
label: Feature or improvement you want
|
||||
description: Try to be as specific as possible. Please not only explain what the feature does, but also how.
|
||||
- type: textarea
|
||||
id: reason
|
||||
attributes:
|
||||
label: Why should this be added?
|
||||
description: What problem does the feature solve? In what use-cases is the feature needed?
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots / Drawings / Technical details
|
||||
description: If your request is about (or includes) changing or extending the UI, describe what the UI would look like and how the user would interact with it.
|
||||
@@ -0,0 +1,13 @@
|
||||
# Description
|
||||
|
||||
## Checklist
|
||||
<!--
|
||||
To help us keep the issue tracker clean and work as efficient as possible,
|
||||
please make sure that you have done all of the following.
|
||||
You can tick the boxes below by placing an x inside the brackets like this: [x]
|
||||
-->
|
||||
- [ ] I have read the contribution guidelines: <https://github.com/callebtc/bitchat-android?tab=readme-ov-file#contributing>
|
||||
- [ ] I have performed a self-review of my code
|
||||
<!-- - [ ] I have run the automated code checks using `./gradlew checkstyle spotbugsPlayDebug spotbugsDebug :app:lintPlayDebug` -->
|
||||
- [ ] I have mentioned the corresponding issue and the relevant keyword (e.g., "Closes: #xy") in the description (see <https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue>)
|
||||
- [ ] If it is a core feature, I have added automated tests
|
||||
@@ -231,7 +231,7 @@ bitchat uses an efficient binary protocol optimized for Bluetooth LE:
|
||||
|
||||
The Android implementation maintains 100% binary protocol compatibility with iOS:
|
||||
- **Header Format**: Identical 13-byte header structure
|
||||
- **Packet Types**: Same message types and routing logic
|
||||
- **Packet Types**: Same message types and routing logic
|
||||
- **Encryption**: Identical cryptographic algorithms and key exchange
|
||||
- **UUIDs**: Same Bluetooth service and characteristic identifiers
|
||||
- **Fragmentation**: Compatible message fragmentation for large content
|
||||
@@ -288,7 +288,7 @@ This Android port enables seamless communication with the original iOS bitchat a
|
||||
Contributions are welcome! Key areas for enhancement:
|
||||
|
||||
1. **Performance**: Battery optimization and connection reliability
|
||||
2. **UI/UX**: Additional Material Design 3 features
|
||||
2. **UI/UX**: Additional Material Design 3 features
|
||||
3. **Security**: Enhanced cryptographic features
|
||||
4. **Testing**: Unit and integration test coverage
|
||||
5. **Documentation**: API documentation and development guides
|
||||
@@ -296,7 +296,7 @@ Contributions are welcome! Key areas for enhancement:
|
||||
## Support & Issues
|
||||
|
||||
- **Bug Reports**: [Create an issue](../../issues) with device info and logs
|
||||
- **Feature Requests**: [Start a discussion](../../discussions)
|
||||
- **Feature Requests**: [Start a discussion](../../discussions)
|
||||
- **Security Issues**: Email security concerns privately
|
||||
- **iOS Compatibility**: Cross-reference with [original iOS repo](https://github.com/jackjackbits/bitchat)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user