lwaekfjlk commited on
Commit
e683429
1 Parent(s): 115a2f6

add the issue and pr template

Browse files
.github/ISSUE_TEMPLATE/bug_report.yml ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: 🐛Bug Report
2
+ description: File a bug report here
3
+ title: "[BUG]: "
4
+ labels: ["bug"]
5
+ assignees: ["JayantGoel001"]
6
+ body:
7
+ - type: markdown
8
+ attributes:
9
+ value: |
10
+ Thanks for taking the time to fill out this bug report 🤗
11
+ Make sure there aren't any open/closed issues for this topic 😃
12
+
13
+ - type: textarea
14
+ id: bug-description
15
+ attributes:
16
+ label: Description of the bug
17
+ description: Give us a brief description of what happened and what should have happened
18
+ validations:
19
+ required: true
20
+
21
+ - type: textarea
22
+ id: steps-to-reproduce
23
+ attributes:
24
+ label: Steps To Reproduce
25
+ description: Steps to reproduce the behavior.
26
+ placeholder: |
27
+ 1. Go to '...'
28
+ 2. Click on '...'
29
+ 3. Scroll down to '...'
30
+ 4. See error
31
+ validations:
32
+ required: true
33
+
34
+ - type: textarea
35
+ id: additional-information
36
+ attributes:
37
+ label: Additional Information
38
+ description: |
39
+ Provide any additional information such as logs, screenshots, likes, scenarios in which the bug occurs so that it facilitates resolving the issue.
.github/ISSUE_TEMPLATE/exp_record.yml ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: 🧪Experiment Record
2
+ description: Describe experiment setting and results here
3
+ title: "[EXP]: "
4
+ labels: ["experiment"]
5
+ assignees: [""]
6
+ body:
7
+ - type: markdown
8
+ attributes:
9
+ value: |
10
+ Please make sure this experiment request hasn't been already submitted by someone by looking through other open/closed issues
11
+
12
+ - type: textarea
13
+ id: description
14
+ attributes:
15
+ label: Description
16
+ description: Give us a brief description of the experimental setting and results you would like
17
+ validations:
18
+ required: true
19
+
20
+ - type: textarea
21
+ id: additional-information
22
+ attributes:
23
+ label: Additional Information
24
+ description: Give us some additional information on the experimental setting and results like learning rate, data selection , etc.
.github/ISSUE_TEMPLATE/feature_request.yml ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: ✨Feature Request
2
+ description: Request a new feature or enhancement
3
+ labels: ["enhancement"]
4
+ title: "[FEAT]: "
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Please make sure this feature request hasn't been already submitted by someone by looking through other open/closed issues
10
+
11
+ - type: textarea
12
+ id: description
13
+ attributes:
14
+ label: Description
15
+ description: Give us a brief description of the feature or enhancement you would like
16
+ validations:
17
+ required: true
18
+
19
+ - type: textarea
20
+ id: additional-information
21
+ attributes:
22
+ label: Additional Information
23
+ description: Give us some additional information on the feature request like proposed solutions, links, screenshots, etc.
.github/ISSUE_TEMPLATE/writing_task.yml ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: 🖊️Writing Task
2
+ description: Describe writing task here
3
+ title: "[WRT]: "
4
+ labels: ["writing"]
5
+ assignees: [""]
6
+ body:
7
+ - type: markdown
8
+ attributes:
9
+ value: |
10
+ Please make sure this writing task request hasn't been already submitted by someone by looking through other open/closed issues
11
+
12
+ - type: textarea
13
+ id: description
14
+ attributes:
15
+ label: Description
16
+ description: Give us a brief description of the writing task you would like
17
+ validations:
18
+ required: true
19
+
20
+ - type: textarea
21
+ id: additional-information
22
+ attributes:
23
+ label: Additional Information
24
+ description: Give us some additional information on the writing task like exptected length, main content, etc.
.github/pull_request_template.md ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!--
2
+ Thanks for creating this pull request 🤗
3
+ Please make sure that the pull request is limited to one type (docs, feature, etc.) and keep it as small as possible. You can open multiple prs instead of opening a huge one.
4
+ -->
5
+
6
+ <!-- If this pull request closes an issue, please mention the issue number below -->
7
+ Closes # <!-- Issue # here -->
8
+
9
+ ## 📑 Description
10
+ <!-- Add a brief description of the pr -->
11
+
12
+ <!-- You can also choose to add a list of changes and if they have been completed or not by using the markdown to-do list syntax
13
+ - [ ] Not Completed
14
+ - [x] Completed
15
+ -->
16
+
17
+ ## ✅ Checks
18
+ <!-- Make sure your pr passes the CI checks and do check the following fields as needed - -->
19
+ - [ ] My pull request adheres to the code style of this project
20
+ - [ ] My code requires changes to the documentation
21
+ - [ ] I have updated the documentation as required
22
+ - [ ] All the tests have passed
23
+ - [ ] Branch name follows `type/descript` (e.g. `feature/add-llm-agents`)
24
+ - [ ] Ready for code review
25
+
26
+ ## ℹ Additional Information
27
+ <!-- Any additional information like breaking changes, dependencies added, screenshots, comparisons between new and old behavior, etc. -->