Template to create new github issue
Contents
Configure template in github
For issue template: Configuring issue templates for your repository – GitHub Docs
For pull request template: Creating a pull request template for your repository – GitHub Docs
Templates
Issue template for new feature – Change password
## What is it?
Need to have change password feature.
## Why should it be done? (Problem)
- User cannot change password.
- Admin cannot change password of other users.
## What is the expected outcome? (Solution)
- Add password field at profile page.
### How should it be done? (Acceptance Criteria)
- [ ] User can change password at profile page.
- [ ] User cannot change other user's password.
- [ ] Admin can change password of other users.
## Reference
- Need to finish issue #xxxx
- Similar to issue #yyyy
Issue template for bug – Able to use Japanese symbol for password field when change password
## What's the Problem?
User can input Japanese character to password field.
## Steps to reproduce
- Log in
- Click on account avatar to go to profile page
- Click link `Change password`
- Input old password
- Input new password with value `インドネシア`
- Click save
## Expected result
- Return error "Invalid password"
- Cannot save
## Current result
- Save successfully
## How should it be done? (Acceptance Criteria)
- [ ] User can input alphabet or number only.
## Reference:
Pull Request template
# Pull Request Template
## 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)
## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Please also note 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
- [ ] Any dependent changes have been merged and published in downstream modules