Skip to content

Commit efabb47

Browse files
committed
Config for welcome bot and update Github templates
1 parent 0005152 commit efabb47

File tree

3 files changed

+56
-15
lines changed

3 files changed

+56
-15
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,37 @@
1-
*Please fill out the fields below to report an error.*
1+
**-- TEMPLATE FOR FEATURE REQUESTS AND FEEDBACK --**
22

3-
## Full code/command that generated the error
3+
## Feedback or description of feature requested
44

5-
## Full error message
5+
*Your text goes here. Please be as specific and detailed as possible.*
66

7-
## System information
87

9-
* Operating system:
10-
* Python installation (Anaconda, system, ETS):
11-
* Version of GMT/Python:
12-
* How you installed GMT/Python:
8+
**Are you willing to help implement and maintain this feature?** Yes/No
139

1410

15-
*If this is a **question or feature request**, delete the above lines and instead:*
1611

17-
* Describe the feature you desire in as much detail as possible:
12+
**-- TEMPLATE FOR BUG REPORTS --** If you're not filing a bug, please delete this part.
1813

19-
* Are you willing to try to implement and maintain this feature?
20-
We'll help you through the process.
14+
## Full code that generated the error
15+
16+
```python
17+
PASTE CODE HERE
18+
```
19+
20+
## Full error message
21+
22+
```
23+
PASTE ERROR MESSAGE HERE
24+
```
25+
26+
## System information
27+
28+
* Operating system:
29+
* Python installation (Anaconda, system, ETS):
30+
* Version of GMT:
31+
* Version of Python:
32+
* Version of this package:
33+
* If using conda, paste the output of `conda list` below:
34+
35+
```
36+
# Output of conda list
37+
```

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
*Please fill out the fields below and follow our [pull request guidelines](CONTRIBUTING.md#pull-requests).*
1+
*Detailed description of changes proposed and why you made them.
2+
If unsure, open an issue first so we can discuss it.
3+
If fixing an issue, put the issue number after the # below (no spaces).*
24

35
Fixes #
4-
5-
## Changes proposed in this pull request

.github/config.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Configuration for welcome bot - https://github.com/behaviorbot/welcome
2+
########################################################################################
3+
# Comment to be posted to on first time issues
4+
newIssueWelcomeComment: |
5+
👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our [contributing guidelines](https://github.com/GenericMappingTools/gmt-python/blob/master/CONTRIBUTING.md) and [code of conduct](https://github.com/GenericMappingTools/gmt-python/blob/master/CODE_OF_CONDUCT.md).
6+
7+
# Comment to be posted to on PRs from first time contributors in your repository
8+
newPRWelcomeComment: |
9+
💖 Thanks for opening this pull request! 💖
10+
11+
Please make sure you read our [contributing guidelines](https://github.com/GenericMappingTools/gmt-python/blob/master/CONTRIBUTING.md) and abide by our [code of conduct](https://github.com/GenericMappingTools/gmt-python/blob/master/CODE_OF_CONDUCT.md).
12+
13+
A few things to keep in mind:
14+
15+
* Remember to run ``make format`` to make sure your code follows our style guide.
16+
* If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
17+
* All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
18+
* No matter what, we are really grateful that you put in the effort to do this! 🎉
19+
20+
# Comment to be posted to on pull requests merged by a first time user
21+
firstPRMergeComment: |
22+
🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉
23+
24+
Please open a new pull request to add yourself to the `AUTHORS.md` file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

0 commit comments

Comments
 (0)