Skip to content

Commit

Permalink
[build] Setting up templates for issues and PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
Zakelly committed Mar 6, 2024
1 parent fa05ea4 commit 5a0e0ae
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 7 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Compile '...'
2. Run '....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. CentOS 7.8]

**Additional context**
Add any other context about the problem here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Have questions
url: https://github.com/ververica/ForSt/discussions/categories/q-a
about: Please ask and answer questions here.
- name: New Ideas
url: https://github.com/ververica/ForSt/discussions/categories/ideas
about: Please suggest your new ideas here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/work_item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Work Item
about: Suggest/Log a work item (For big ideas and proposals, please go to New Ideas)
title: ''
labels: ''
assignees: ''

---

**What is this for**
A clear and concise description of what the item is.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
44 changes: 44 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!--
*Thank you very much for contributing to ForSt.
## Contribution Checklist
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests.
- Each pull request should address only one issue, not mix up code from multiple issues.
- The title of this PR should start with module name, such as [build] / [core] / [JNI] ...
-->

## What is the purpose of the change

*(For example: This pull request enables caching all the java classes that will be frequently used.)*


## Brief change log

*(for example:)*
- *A global cache container*
- *Cache entries for each objects*


## Verifying this change

*(Please pick either of the following options)*

This change is a trivial rework / code cleanup without any test coverage.

*(or)*

This change is already covered by existing tests, such as *(please describe tests)*.

*(or)*

This change added tests and can be verified as follows:

*(example:)*
- *first step*
- *second step*
- *third step, and xxx behaves as expected*
7 changes: 0 additions & 7 deletions issue_template.md

This file was deleted.

0 comments on commit 5a0e0ae

Please sign in to comment.