Skip to content

Commit

Permalink
PR template for blog posts and development work to improve our blog (#…
Browse files Browse the repository at this point in the history
…130)

* adding PR template for blogs

* change file name

* adding an additional template for PRs related to development work

* adding page to select the appropriate PR template
  • Loading branch information
koebel committed Jun 4, 2024
1 parent 0050775 commit 98023d1
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/BLOG_POST_PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
Thanks for writing making a PR to our company blog!
By sharing your knowhow and insights with others through writing blog posts,
you are not only advancing your own career,
but also making a meaningful contribution to the global developers community!
To simplify the review process, please fill in the information below.
-->

## Motivation And Context
### Key Message
<!---
Describe the aim of your blog post in one or two sentences.
Knowing your goal of writing makes it easier for reviewing your blog post,
in particular if feedback is asked for at an earlier stage of writing.
-->

### Target Audience
<!---
Briefly describe for whom you are writing this blog post (beginners, experience software developers,
general audience, etc.). This information too is very helpful for the reviewers of your blog post.
-->

## Current Status
<!-- We encourage you to ask the team for feedback in an early stage of writing a blog post.
Specifying the steps that have already been completed and what aspects are are still in process
helps your friends who are reviewing your blog post -->
- [ ] Topic defined (working title, key message)
- [ ] Audience defined
- [ ] Content outline created
- [ ] Assets (images, illustrations, code samples, etc.) created
- [ ] Draft for each paragraph including introduction and conclusion written
- [ ] Header image created
- [ ] Title finalized
- [ ] Keywords added
- [ ] Blog post is ready for final review

## Declaration Of Sources
- [ ] I have given adequate reference to all external sources I've used
(e.g. images, illustrations, quotations from other blogs and publications, etc.)
45 changes: 45 additions & 0 deletions .github/DEVELOPMENT_PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!--
Thanks for submitting a PR to improve our JankariTech blog!
To simplify the review process, please fill in the information below and set the following labels:
- Assignment: assign to self
- Reviewers: pick at least one
-->

## Description
<!--- Briefly describe your changes -->

## Related Issue
- Fixes <issue_link>
- Part of <issue_link>

## Motivation And Context
<!--- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?
<!--- Please describe how you tested your changes. -->
- test environment:
- test case 1:
- test case 2:

## Screenshots (If Appropriate):

## Types Of Changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] 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 change)
- [ ] Technical debt
- [ ] Tests
- [ ] Documentation
- [ ] Maintenance (e.g. dependency updates or tooling)

## Checklist:
- [ ] Code changes
- [ ] Unit tests added
- [ ] Acceptance tests added
- [ ] Documentation updated

## Open tasks:
<!-- In case of incomplete PR, please list the open tasks here -->
- [ ] ...
4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Please go the the `Preview` tab and select the appropriate PR template:

* [submitting a PR for a blog post](?expand=1&template=BLOG_POST_PULL_REQUEST_TEMPLATE.md)
* [submitting a PR for some development improvements in our blog](?expand=1&template=DEVELOPMENT_PULL_REQUEST_TEMPLATE.md)

0 comments on commit 98023d1

Please sign in to comment.