Skip to content

Commit

Permalink
Merge pull request #266 from dianzrong/add-contributing-md
Browse files Browse the repository at this point in the history
Update Contributing Templates
  • Loading branch information
abrichr authored Jun 16, 2023
2 parents 0cd5c54 + 40fd85e commit 8653d0c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_form.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ body:
attributes:
label: Describe the bug
description: What behaviour was expected and what actually happened? Include screenshots and log output where useful.
value: I expected ... but what actually happened was ...
placeholder: I expected ... but what actually happened was ...
validations:
required: true
- type: textarea
id: steps
attributes:
label: To Reproduce
description: What Operating System did you use and steps would we take to reproduce the behaviour?
value: "I use [macOS/Microsoft Windows].
placeholder: "I use [macOS/Microsoft Windows].
Steps:
1. Go to '...'
2. Click on '....'
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new_feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ body:
attributes:
label: Motivation
description: Please outline the purpose for the proposal (e.g., is it related to a problem?). Add any relevant links (e.g. GitHub issues).
value: I'm always frustrated when [...] so this feature would [...].
placeholder: I'm always frustrated when [...] so this feature would [...].
19 changes: 10 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
<!-- Thanks for submitting a pull request! Please provide information so we can quickly review your pull request. -->
<!-- Thank you for submitting a pull request! To ensure a prompt review of your changes, please provide the following information. -->

**What kind of change does this PR introduce?**

<!-- E.g. a bugfix, feature, refactoring, etc… -->

**Summary**

<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? Try to link to an open issue. -->

**Checklist**
* [ ] My code follows the style guidelines of this project
* [ ] I have pefomed a self-review of my code
* [ ] My code follows the style guidelines of OpenAdapt
* [ ] I have perfomed a self-review of my code
* [ ] If applicable, I have added tests to prove my fix is functional/effective
* [ ] I have linted my code locally prior to submission
* [ ] I have commented my code, particularly in hard-to-understand areas
* [ ] I have made corresponding changes to the documentation (e.g. README.md, requirements.txt)
* [ ] New and existing unit tests pass locally with my changes

**Summary**

<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? Try to link to an open issue. -->

**How can your code be run and tested?**

<!-- See the README.md for examples. -->
<!-- See the README.md for examples. Include test output. -->


**Other information**
**Other information**
<!-- Delete this subheading if no additional context is needed. -->

0 comments on commit 8653d0c

Please sign in to comment.