Skip to content

Commit 442041d

Browse files
committed
Add pull request templates
1 parent dee2aaf commit 442041d

File tree

4 files changed

+124
-1
lines changed

4 files changed

+124
-1
lines changed
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Add a script
3+
about: Add a new script in repository
4+
title: "script_name.py X.Y: fix..."
5+
labels: new script
6+
7+
---
8+
9+
## Script info
10+
11+
<!-- MANDATORY INFO: -->
12+
13+
- Script name: 
14+
- Version: 
15+
- License: 
16+
17+
<!-- Optional: external dependencies -->
18+
- Requirements: 
19+
20+
<!-- Optional: fill only if you are sure that a specific WeeChat version is required -->
21+
- Min WeeChat version: 
22+
23+
<!-- Optional: tags for script (see list of tags on https://weechat.org/scripts/), new tags are allowed -->
24+
- Script tags: 
25+
26+
## Description
27+
28+
<!-- Describe the script in a few sentences -->
29+
30+
31+
32+
## Checklist
33+
34+
<!-- Please check each item with "[x]" and ensure your script is compliant -->
35+
<!-- See file Contributing.md for more information -->
36+
37+
- [ ] Single commit, single file added
38+
- [ ] Commit message: `New script name.py: short description…`
39+
- [ ] No similar script already exists
40+
- [ ] Name: max 32 chars, only lower case letters, digits and underscores
41+
- [ ] Unique name, does not already exist in repository
42+
- [ ] No shebang on the first line
43+
- [ ] Comment in script with name/pseudo, e-mail and license
44+
- [ ] Only English in code/comments
45+
- [ ] Pure WeeChat API used, no extra API
46+
- [ ] Function `hook_process` is used for blocking calls
47+
- [ ] For Python script: works with Python 3 (Python 2 support is optional)
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Fix a script
3+
about: Fix bugs in a script
4+
title: "script_name.py X.Y: "
5+
labels: bug
6+
7+
---
8+
9+
<!-- Please do not fix any security issue here, see file Contributing.md -->
10+
11+
## Script info
12+
13+
<!-- MANDATORY INFO: -->
14+
15+
- Script name: 
16+
- New version: 
17+
18+
<!-- Optional: fill only if you are sure that the new version now requires another specific WeeChat version -->
19+
- New min WeeChat version: 
20+
21+
<!-- Optional: fill only if there are new requirements -->
22+
- New requirements: 
23+
24+
## Bugs fixed
25+
26+
<!-- Describe the bugs(s) you are fixing in this pull request -->
27+
28+
29+
30+
## Checklist
31+
32+
<!-- Please check each item with "[x]" and ensure the script is compliant -->
33+
<!-- See file Contributing.md for more information -->
34+
35+
- [ ] Author has been contacted
36+
- [ ] Single commit, single file added
37+
- [ ] Commit message format: `script_name.py X.Y: fix some bug…`
38+
- [ ] Script version and Changelog have been updated
39+
- [ ] For Python script: works with Python 3 (Python 2 support is optional)
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Improve a script
3+
about: Add new features in a script
4+
title: "script_name.py X.Y: "
5+
labels: feature
6+
7+
---
8+
9+
## Script info
10+
11+
<!-- MANDATORY INFO: -->
12+
13+
- Script name: 
14+
- New version: 
15+
16+
<!-- Optional: fill only if you are sure that the new version now requires another specific WeeChat version -->
17+
- New min WeeChat version: 
18+
19+
<!-- Optional: fill only if there are new requirements -->
20+
- New requirements: 
21+
22+
## Features added
23+
24+
<!-- Describe the feature(s) you are adding in this pull request -->
25+
26+
27+
28+
## Checklist
29+
30+
<!-- Please check each item with "[x]" and ensure the script is compliant -->
31+
<!-- See file Contributing.md for more information -->
32+
33+
- [ ] Author has been contacted
34+
- [ ] Single commit, single file added
35+
- [ ] Commit message format: `script_name.py X.Y: add feature…`
36+
- [ ] Script version and Changelog have been updated
37+
- [ ] For Python script: works with Python 3 (Python 2 support is optional)

Contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ New scripts are added with pull requests against master branch of this repositor
99
- pull request:
1010
- fill the pull request template
1111
- make only one commit with one new file (the new script) in the appropriate directory, for example `python/` if you add a new Python script
12-
- use this commit message: `New script name.py: short description of the script`
12+
- use this commit message: `New script name.py: short description…`
1313
- script feature:
1414
- check that no script or [pending script](https://github.com/weechat/scripts/pulls) does exactly same thing as your script
1515
- script name:

0 commit comments

Comments
 (0)