mirror of
https://github.com/Hamza417/Inure.git
synced 2026-03-13 10:19:43 +08:00
Add proper issue templates
This commit is contained in:
Hamza417
40
.github/CONTRIBUTING.md
vendored
Normal file
40
.github/CONTRIBUTING.md
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
Thank you for considering contributing to Inure! Here are some guidelines to help you get
|
||||
started:
|
||||
|
||||
## How to Contribute
|
||||
|
||||
1. **Fork the repository**: Click the "Fork" button at the top right of the repository page.
|
||||
2. **Clone your fork**: Clone your forked repository to your local machine.
|
||||
```sh
|
||||
git clone https://github.com/Hamza417/Inure.git
|
||||
```
|
||||
3. **Create a branch**: Create a new branch for your contribution.
|
||||
```sh
|
||||
git checkout -b your-branch-name
|
||||
```
|
||||
4. **Make changes**: Make your changes to the codebase.
|
||||
5. **Commit your changes**: Commit your changes to your branch.
|
||||
```sh
|
||||
git commit -m "Your message here"
|
||||
```
|
||||
6. **Push your changes**: Push your changes to your forked repository.
|
||||
```sh
|
||||
git push origin your-branch-name
|
||||
```
|
||||
7. **Submit a pull request**: Go to the original repository and click the "New pull request" button.
|
||||
8. **Wait for review**: Wait for your pull request to be reviewed and merged.
|
||||
9. **Sync your fork**: Sync your forked repository with the original repository.
|
||||
```sh
|
||||
git remote add upstream
|
||||
git fetch upstream
|
||||
git checkout main
|
||||
git merge upstream/main
|
||||
git push origin main
|
||||
```
|
||||
10. **Delete your branch**: After your pull request has been merged, you can delete your branch.
|
||||
```sh
|
||||
git branch -d your-branch-name
|
||||
```
|
||||
11. **Celebrate**: Your contribution has been merged! 🎉
|
||||
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,32 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a bug report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. Pixel 6]
|
||||
- OS: [e.g. AOSP Android 13]
|
||||
- Version [e.g. Build60]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
91
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
91
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,91 @@
|
||||
name: Bug Report
|
||||
description: Report a bug or a functional problem in the app.
|
||||
title: "[Bug] Your Title Here"
|
||||
labels: [ bug ]
|
||||
assignees: [ Hamza417 ]
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible.
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation
|
||||
attributes:
|
||||
label: Confirmation
|
||||
description: |
|
||||
Please confirm the following:
|
||||
options:
|
||||
- label: I have read the [Code of Conduct](https://github.com/Hamza417/Inure/blob/master/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
- label: I have searched the existing issues
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: bug_description
|
||||
attributes:
|
||||
label: Bug Description
|
||||
description: A clear and concise description of what the bug is.
|
||||
placeholder: Describe the bug here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps_to_reproduce
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: |
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
placeholder: List the steps here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: expected_behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
placeholder: Describe the expected behavior here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots
|
||||
description: If applicable, add screenshots to help explain your problem else N/A.
|
||||
placeholder: Provide links to screenshots here
|
||||
|
||||
- type: input
|
||||
id: device_info
|
||||
attributes:
|
||||
label: Device Information
|
||||
description: |
|
||||
Please complete the following information:
|
||||
- Device: [e.g. Pixel 8]
|
||||
- OS: [e.g. Android 14]
|
||||
placeholder: Provide device information here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional_context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context about the problem here.
|
||||
placeholder: Provide additional context here
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation_2
|
||||
attributes:
|
||||
label: Sufficiency Confirmation
|
||||
description: |
|
||||
Please confirm the following:
|
||||
options:
|
||||
- label: I have provided all the information requested above and deemed sufficient for the developer to address the issue
|
||||
required: true
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Code of Conduct
|
||||
url: https://github.com/Hamza417/Inure/blob/master/CODE_OF_CONDUCT.md
|
||||
about: Please read and adhere to our Code of Conduct before submitting an issue. Any violation of our Code of Conduct will result in the immediate closure of the issue and a possible ban from the repository.
|
||||
- name: Contribution Guidelines
|
||||
url: https://github.com/Hamza417/Inure/blob/master/.github/CONTRIBUTING.md
|
||||
about: Please follow our Contribution Guidelines before submitting a pull request.
|
||||
91
.github/ISSUE_TEMPLATE/error_report.yml
vendored
Normal file
91
.github/ISSUE_TEMPLATE/error_report.yml
vendored
Normal file
@@ -0,0 +1,91 @@
|
||||
name: Error Report
|
||||
description: Report an error or a crash in the app.
|
||||
title: "[Error] Your Title Here"
|
||||
labels: [ error ]
|
||||
assignees: [ Hamza417 ]
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this error report! Please provide as much detail as possible.
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation
|
||||
attributes:
|
||||
label: Confirmation
|
||||
description: |
|
||||
Please confirm the following:
|
||||
options:
|
||||
- label: I have read the [Code of Conduct](https://github.com/Hamza417/Inure/blob/master/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
- label: I have searched the existing issues
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: error_description
|
||||
attributes:
|
||||
label: Error Description
|
||||
description: A clear and concise description of what the error is or how it happened.
|
||||
placeholder: Describe the error here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps_to_reproduce
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: |
|
||||
Steps to reproduce the error:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
placeholder: List the steps here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: expected_behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
placeholder: Describe the expected behavior here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: error_logs
|
||||
attributes:
|
||||
label: Error Logs
|
||||
description: If applicable, add error logs to help explain your problem else N/A.
|
||||
placeholder: Provide error logs here
|
||||
|
||||
- type: input
|
||||
id: device_info
|
||||
attributes:
|
||||
label: Device Information
|
||||
description: |
|
||||
Please complete the following information:
|
||||
- Device: [e.g. Pixel 8]
|
||||
- OS: [e.g. Android 14]
|
||||
placeholder: Provide device information here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional_context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context about the problem here.
|
||||
placeholder: Provide additional context here
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation_2
|
||||
attributes:
|
||||
label: Sufficiency Confirmation
|
||||
description: |
|
||||
Please confirm the following:
|
||||
options:
|
||||
- label: I have provided all the information requested above and deemed sufficient for the developer to address the issue
|
||||
required: true
|
||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,20 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
65
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
65
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
name: Feature Request
|
||||
description: Suggest a new feature or enhancement.
|
||||
title: "[Feature Request] Your Title Here"
|
||||
labels: [ feature request ]
|
||||
assignees: [ Hamza417 ]
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for suggesting a feature! Please provide as much detail as possible.
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation
|
||||
attributes:
|
||||
label: Confirmation
|
||||
description: |
|
||||
Please confirm the following:
|
||||
options:
|
||||
- label: I have read the [Code of Conduct](https://github.com/Hamza417/Inure/blob/master/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
- label: I have searched the existing issues
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: feature_description
|
||||
attributes:
|
||||
label: Feature Description
|
||||
description: A clear and concise description of what the feature is and what problem it solves.
|
||||
placeholder: Describe the feature here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: solution
|
||||
attributes:
|
||||
label: Describe the Solution
|
||||
description: A clear and concise description of what you want to happen.
|
||||
placeholder: Describe the solution here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Describe Alternatives
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
placeholder: Describe alternatives here
|
||||
|
||||
- type: textarea
|
||||
id: additional_context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
placeholder: Provide additional context here
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation_2
|
||||
attributes:
|
||||
label: Sufficiency Confirmation
|
||||
description: |
|
||||
Please confirm the following:
|
||||
options:
|
||||
- label: I have provided all the information requested above and deemed sufficient for the developer to address the issue
|
||||
required: true
|
||||
66
CODE_OF_CONDUCT.md
Normal file
66
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# Code of Conduct
|
||||
|
||||
## My Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, I pledge to make participation in my
|
||||
project and community a harassment-free experience for everyone, regardless of age, body size,
|
||||
disability, ethnicity, gender identity and expression, level of experience, nationality, personal
|
||||
appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## My Standards
|
||||
|
||||
Examples of behavior that contribute to creating a positive environment include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic address, without explicit
|
||||
permission
|
||||
- Use of condescending or offensive language
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## My Responsibilities
|
||||
|
||||
As the project maintainer, I am responsible for clarifying standards of acceptable behavior and am
|
||||
expected to take appropriate and fair corrective action in response to any instances of unacceptable
|
||||
behavior.
|
||||
|
||||
I have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
|
||||
issues, and other contributions that do not align with this Code of Conduct, or to ban temporarily
|
||||
or permanently any contributor for behaviors that I deem inappropriate, threatening, offensive, or
|
||||
harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is
|
||||
representing the project or its community. Examples of representing a project or community include
|
||||
using an official project email address, posting via an official social media account, or acting as
|
||||
an appointed representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by me.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
|
||||
me.
|
||||
All complaints will be reviewed and investigated, resulting in a response deemed necessary and
|
||||
appropriate
|
||||
to the circumstances. I am obligated to maintain confidentiality with regard to the reporter of an
|
||||
incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Those who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
|
||||
repercussions, as determined by other members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from
|
||||
the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available
|
||||
at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
|
||||
Reference in New Issue
Block a user