Skip to content

Commit

Permalink
Merge pull request #1155 from finos/pr-template
Browse files Browse the repository at this point in the history
Adds PR templates for bugfix, documentation, and feature
  • Loading branch information
texodus authored Aug 26, 2020
2 parents bc97557 + 935ef8c commit cf49688
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Bugfix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: 🐛 Bug Fix
about: Fixes a bug reported in our issues list 📕

---

# Bugfix

<!--- Describe your changes in detail. How does it fix the issue? Do you
have any questions about your approach/places for future improvement? -->

## Testing

<!--- Describe in detail how your changes have been tested - were tests added
or changed? -->

## Screenshots (if appropriate)

<!--- If the bug report had a screenshot/could be reproduced visually,
please include a screenshot showing the fix. -->

## Checklist

<!--- If you have any questions, please reach out! We are here to help. -->

- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/finos/perspective/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/finos/perspective/blob/master/CONTRIBUTING.md#guidelines)
- [ ] I have linted my code locally, following the project's code style
- [ ] I have tested my changes locally, and changes pass on the Azure Pipelines CI.
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 📄 Documentation
about: Improves documentation for the API or on the docs website.

---

# Documentation

<!--- Describe your documentation additions/improvements in detail here. -->

## Validation

<!--- Describe how you have validated your documentation additions:
1. Run `yarn docs` from the project root to regenerate the API documentation
from source.
2. Inside the `/docs` subdirectory, run `yarn start` to generate the
Docusaurus site, and validate that your documentation is formatted
and styled correctly.
-->

- [ ] I have linted, spell-checked, and grammar-checked my documentation additions.
- [ ] I have run `yarn docs` to regenerate the API documentation from source.
- [ ] Within `/docs`, I have run `yarn start` to regenerate the Docusaurus site, and I have validated the changes
- [ ] My additions are styled and structured correctly on the Docusaurus site

## Checklist

<!--- If you have any questions, please reach out! We are here to help. -->

- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/finos/perspective/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/finos/perspective/blob/master/CONTRIBUTING.md#guidelines)
54 changes: 54 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: New Feature
about: Adds a new feature to Perspective 🙂!

---

# Feature

<!--- Describe your feature addition and all changes you've made in detail.
- What was the motivation for the feature change?
- How were your changes implemented?
- If necessary, were your changes implemented in both the Javascript and Python bindings?
- Have you considered any alternative approaches that weren't implemented?
- Do you have any questions about your approach/places for future improvement?
-->

<!--- Check one box below. If you are unsure as to whether your feature changes
are breaking, tag a core contributor: @texodus, @timkpaine, @sc1f or leave a
comment. --->

- [ ] Breaking feature
- [ ] Non-breaking feature


## Changelog

- {A bullet-pointed changelog that outlines the contents of your PR.}

## Testing

<!--- Describe in detail how your changes have been tested.
- Have tests been added or changed?
- Have you used the examples folder to test your new feature?
- If useful, were new examples created for others to check out?
- If your feature adds new public APIs/changes only one binding (JS _or_ Python),
has the equivalent API been implemented and tested in the other binding language?
-->

## Screenshots (if appropriate)

<!--- If your feature is accessible via the UI/can be seen visually, please
include a screenshot (or a few!). -->

## Checklist

<!--- If you have any questions, please reach out! We are here to help. -->

- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/finos/perspective/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/finos/perspective/blob/master/CONTRIBUTING.md#guidelines)
- [ ] I have linted my code locally, following the project's code style
- [ ] I have tested my changes locally, and changes pass on the Azure Pipelines CI.

0 comments on commit cf49688

Please sign in to comment.