Skip to content

Commit

Permalink
Merge pull request #66 from Gilead-BioStats/contributing
Browse files Browse the repository at this point in the history
Add contributing documents
  • Loading branch information
EeethB authored Dec 18, 2023
2 parents 918a2b2 + c359a34 commit 7513706
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Bug Report
description: Something is not working correctly or is not working at all!
title: "Bug: <Insert Issue Title Here>"
labels: ["bug", "programming"]
body:
- type: markdown
attributes:
value: |
**Example:** Bug: graph_calculate_power() errors on certain input
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us what were you expecting to happen before the bug?
placeholder: "A bug happened!"
validations:
required: true
- type: textarea
id: session-info
attributes:
label: Session Information
description: Use `sessionInfo()` in the R console to gather all the details of your environment when the bug happened.
placeholder: "Place the console output here"
validations:
required: false
- type: textarea
id: logs
attributes:
label: Reproducible Example
description: We love code that can reproduce the bug. Check out [reprex](https://reprex.tidyverse.org/articles/reprex-dos-and-donts.html)
placeholder: "Please give us as many details as you can! The faster we can recreate the bug, the faster we can get a fix in the works. Warning, Error Messages and Screenshots are also great."
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/02_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Feature Request
description: Enchancement to graphicalMCP functionality
title: "Feature Request: <Insert Issue Title Here>"
labels: ["enhancement", "programming"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request! We love keeping graphicalMCP fresh!
- type: textarea
id: feature
attributes:
label: Feature Idea
description: Tell us your idea in as few words as possible
placeholder: "`graph_test_closure` should support such and such test"
validations:
required: true
- type: textarea
id: input
attributes:
label: Relevant Input
description: Can you provide what the inputs should look like?
placeholder: "What should the input look like? REMINDER: No patient level data or company sensitive information should be shared via this open public issue"
validations:
required: false
- type: textarea
id: output
attributes:
label: Relevant Output
description: Can you provide what the final output should look like?
placeholder: "What should the output look like? REMINDER: No patient level data or company sensitive information should be shared via this open public issue"
validations:
required: false
- type: textarea
id: code
attributes:
label: Reproducible Example/Pseudo Code
description: Can you provide a working example or a sketch of how the code should work?
placeholder: "We love example code, and it will speed up the process! REMINDER: No patient level data or company sensitive information should be shared via this open public issue"
validations:
required: false
27 changes: 27 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
### Thank you for your Pull Request!

We have developed a Pull Request template to aid you and our reviewers. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the graphicalMCP codebase remains robust and consistent.

### Changes Description

_(descriptions of changes)_

### Task List

This is a list of tasks that can be done by contributors to make reviewing faster and more straightforward. If you're unsure how to do any or all of these, please make your contributions anyway. We are happy to work with you on any of them! However, know that your contributions may be more likely to be accepted, or be accepted more quickly, the more of these you can accomplish. They are roughly sorted in descending order of helpfulness.

- [ ] Fill out **Changes Description** above
- [ ] Update relevant unit tests or write new unit tests
- [ ] Create/update relevant roxygen headers and examples
- [ ] Run `pkgdown::build_site()` and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page
- [ ] Update NEWS.md with a brief summary of changes made - Note the related issue number(s) at the end like (#000)
- [ ] Make sure that the package versions in the NEWS.md and DESCRIPTION file are the same
- [ ] Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
- [ ] Format code according to the [tidyverse style guide](https://style.tidyverse.org/) (Run `styler::style_pkg()`)
- [ ] Run `devtools::document()` so all `.Rd` files in the `man` folder and the `NAMESPACE` file in the project root are updated appropriately
- [ ] Address any updates needed for vignettes and/or templates
- [ ] Link the issue Development Panel so that the related issue closes after successful merging
- [ ] Fix merge conflicts
- [ ] Pat yourself on the back for a job well done! Here's a random cat gif for your hard work :)

<img src="http://edgecats.net/' + Math.random() + 0 + '"/>

0 comments on commit 7513706

Please sign in to comment.