mirror of
https://github.com/sudoxnym/habitica-android.git
synced 2026-04-14 11:46:32 +00:00
Add GitHub issue templates and contribution guidelines
- Add bug report, feature request, and task issue templates - Add pull request template - Add contributing guidelines - Add code of conduct
This commit is contained in:
parent
a51d4d50c9
commit
f64144ba73
7 changed files with 210 additions and 0 deletions
46
Habitica/.github/CODE_OF_CONDUCT.md
vendored
Normal file
46
Habitica/.github/CODE_OF_CONDUCT.md
vendored
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our 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.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes 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 by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/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
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they 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 e-mail 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 project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at admin@habitica.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers 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][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
46
Habitica/.github/CONTRIBUTING.md
vendored
Normal file
46
Habitica/.github/CONTRIBUTING.md
vendored
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# Contributing to Habitica Android
|
||||
|
||||
Thank you for your interest in contributing to Habitica! We welcome contributions from the community.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
## How to Contribute
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/HabitRPG/habitica-android/issues).
|
||||
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/HabitRPG/habitica-android/issues/new/choose). Be sure to follow one of our issue templates.
|
||||
|
||||
### Suggesting Enhancements
|
||||
|
||||
- Open a new issue using the feature request template.
|
||||
- Provide a clear and detailed explanation of the feature you want to see implemented.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a new branch for your feature or bug fix
|
||||
3. Write your code
|
||||
4. Add tests if applicable
|
||||
5. Ensure your code follows the existing style
|
||||
6. Submit a pull request with a clear description of your changes
|
||||
|
||||
## Development Setup
|
||||
|
||||
1. Clone your fork of the repository
|
||||
2. Open the project in Android Studio
|
||||
3. Make your changes
|
||||
4. Test your changes thoroughly
|
||||
|
||||
## Style Guidelines
|
||||
|
||||
- Follow the existing code style
|
||||
- Write clear, concise commit messages
|
||||
- Comment your code where necessary
|
||||
- Write unit tests for new functionality
|
||||
|
||||
## Questions?
|
||||
|
||||
If you have any questions, feel free to reach out to the Habitica team through our [contact form](https://habitica.com/static/contact).
|
||||
36
Habitica/.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
36
Habitica/.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
name: Bug Report
|
||||
about: Create a report to help us improve
|
||||
title: '[Bug] '
|
||||
labels: bug
|
||||
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.
|
||||
|
||||
## Actual Behavior
|
||||
A clear and concise description of what actually happened.
|
||||
|
||||
## Screenshots
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
## Device Information
|
||||
- Device: [e.g. Samsung Galaxy S21]
|
||||
- OS: [e.g. Android 11]
|
||||
- App Version: [e.g. 3.4.5]
|
||||
- Branch/Commit: [if applicable]
|
||||
|
||||
## Additional Context
|
||||
Add any other context about the problem here.
|
||||
8
Habitica/.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
Habitica/.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Habitica Support
|
||||
url: https://habitica.com/static/contact
|
||||
about: For questions about using Habitica, please contact our support team.
|
||||
- name: Habitica Wiki
|
||||
url: https://habitica.fandom.com/wiki/Habitica_Wiki
|
||||
about: Check the wiki for information about Habitica features.
|
||||
23
Habitica/.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
23
Habitica/.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
name: Feature Request
|
||||
about: Suggest an idea for this project
|
||||
title: '[Feature] '
|
||||
labels: enhancement
|
||||
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.
|
||||
|
||||
## Implementation Notes
|
||||
If you have any technical details about how this feature could be implemented, please share them here.
|
||||
25
Habitica/.github/ISSUE_TEMPLATE/task.md
vendored
Normal file
25
Habitica/.github/ISSUE_TEMPLATE/task.md
vendored
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
name: Task
|
||||
about: Technical task or chore
|
||||
title: '[Task] '
|
||||
labels: task
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Description
|
||||
A clear and concise description of the task that needs to be done.
|
||||
|
||||
## Requirements
|
||||
- [ ] Requirement 1
|
||||
- [ ] Requirement 2
|
||||
- [ ] Requirement 3
|
||||
|
||||
## Implementation Notes
|
||||
Any technical details or implementation guidance.
|
||||
|
||||
## Related Issues
|
||||
Any related issues or PRs.
|
||||
|
||||
## Definition of Done
|
||||
What needs to be completed for this task to be considered finished?
|
||||
26
Habitica/.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
26
Habitica/.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
## Description
|
||||
<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
|
||||
|
||||
Fixes #(issue)
|
||||
|
||||
## Type of Change
|
||||
<!-- Please delete options that are not relevant. -->
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] This change requires a documentation update
|
||||
|
||||
## How Has This Been Tested?
|
||||
<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. -->
|
||||
- [ ] Test A
|
||||
- [ ] Test B
|
||||
|
||||
## Checklist:
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
||||
Loading…
Reference in a new issue