Skip to content

Commit a5d09f7

Browse files
mdtankermdtanker
authored
updates to template and instructions (#1)
Change the default from `packagename` to `samplepackagename` which is available on `PyPI`. Also adds some additional files which were missing, such as `.git_archival.txt`, `ISSUE_TEMPLATES` for GitHub issues, and `CHANGELOG.md`. More detailed instructions on how to use the template and how contributors can contribute to the created package.
1 parent 233a8b7 commit a5d09f7

28 files changed

Lines changed: 785 additions & 486 deletions

‎.git_archival.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node: $Format:%H$
2+
node-date: $Format:%cI$
3+
describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$

‎.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.git_archival.txt export-subst

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Report a problem/bug to help us improve.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Full code that generate the error**
14+
<!--
15+
Include any data files or inputs required to run the code. It really helps if
16+
we can run the code on our own machines.
17+
-->
18+
19+
<!-- blacken-docs:off -->
20+
```python
21+
PASTE YOUR CODE HERE
22+
```
23+
<!-- blacken-docs:on -->
24+
25+
**Full error message**
26+
27+
<!-- blacken-docs:off -->
28+
```
29+
PASTE ERROR MESSAGE HERE
30+
```
31+
<!-- blacken-docs:on -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
**Description of the desired feature:**
10+
11+
<!--
12+
Add as much detail as you can in your description below. If possible, include an
13+
example of how you would like to use this feature (even better if it's a code
14+
example).
15+
-->
16+
17+
**Are you willing to help implement and maintain this feature?**
18+
19+
<!--
20+
Every feature we add is code that we will have to maintain and keep updated.
21+
Please let us know if you're willing to help maintain this feature in the future.
22+
-->

‎.github/ISSUE_TEMPLATE/release_checklist.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Release checklist
3+
about: 'Maintainers only: Checklist for making a new release'
4+
title: 'Release vX.Y.Z'
5+
labels: 'maintenance'
6+
assignees: ''
7+
8+
---
9+
10+
**Zenodo DOI:**
11+
12+
<!-- Optional -->
13+
**Target date:** YYYY/MM/DD
14+
15+
## Draft a Zenodo archive (to be done by a manager on Zenodo)
16+
17+
- [ ] Go to the Zenodo entry for this project (find the link to the latest Zenodo release on the `README.md` file)
18+
- [ ] Create a "New version" of it.
19+
- [ ] Get a new DOI for the new release
20+
- [ ] Copy and paste the reserved DOI to this issue
21+
- [ ] Update release date
22+
- [ ] Update version number in Title (make sure there is a leading `v`, like `v1.5.7`)
23+
- [ ] Update version number (use a leading `v` as well)
24+
- [ ] Add as authors any new contributors who have added themselves to `AUTHORS.md` in the same order
25+
- [ ] Ensure that the first author is "samplepackagename Developers" and others are listed alphabetically by last name
26+
- [ ] Save the release draft
27+
28+
## Update the changelog
29+
30+
- [ ] Generate a list of commits between the last release tag and now: `git log HEAD...v1.2.3 > changes.md`
31+
- [ ] Use this to summary the major changes to the code and add short descriptions to `CHANGELOG.md` (not `docs/changelog.md`!).
32+
- [ ] Add the release date and Zenodo DOI badge to the top
33+
- [ ] Add contributors to the list
34+
- [ ] Open a PR to update the changelog
35+
- [ ] Merge the PR
36+
37+
## Make a release
38+
39+
After the changelog PR is merged:
40+
41+
- [ ] Draft a new release on GitHub
42+
- [ ] The tag and release name should be a version number (following Semantic Versioning) with a leading `v` (`v1.5.7`)
43+
- [ ] Fill the release description with a Markdown version of the latest changelog entry (including the DOI badge)
44+
- [ ] Publish the release
45+
46+
## Publish to Zenodo
47+
48+
- [ ] Upload the zip archive from the GitHub release to Zenodo
49+
- [ ] Double check all information (date, authors, version)
50+
- [ ] Publish the new version on Zenodo
51+
52+
## Conda-forge package
53+
54+
A PR should be opened automatically on the project feedstock repository.
55+
56+
- [ ] Add/remove/update any dependencies that have changed in `meta.yaml`
57+
- [ ] If dropping/adding support for Python/numpy versions, make sure the correct version restrictions are applied in `meta.yaml`
58+
- [ ] Merge the PR

‎.github/config.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Inspired by [PyGMT](https://github.com/GenericMappingTools/pygmt) welcome messages.
2+
# Configuration for welcome - https://github.com/behaviorbot/welcome
3+
4+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
5+
6+
# Comment to be posted to on first time issues
7+
newIssueWelcomeComment: >
8+
👋 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/organizationname/samplepackagename/CONTRIBUTING.md).
9+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
10+
11+
# Comment to be posted to on PRs from first time contributors in your repository
12+
newPRWelcomeComment: >
13+
⭐ Thanks for opening this pull request! ⭐
14+
Please make sure you read our [contributing guidelines](https://github.com/organizationname/samplepackagename/CONTRIBUTING.md).
15+
A few things to keep in mind:
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+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
20+
21+
# Comment to be posted to on pull requests merged by a first time user
22+
firstPRMergeComment: >
23+
🎉 Congrats on merging your first pull request and welcome to the team! 🎉
24+
25+
**If you would like to be added as a author** on the Zenodo archive of the next release, add your full name, affiliation, and [ORCID](https://orcid.org) (optional) to the `AUTHORS.md` file of this repository. Feel free to do this in a new pull request if needed.
26+
27+
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.
28+

‎.pre-commit-config.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ ci:
22
autoupdate_commit_msg: "chore: update pre-commit hooks"
33
autofix_commit_msg: "style: pre-commit fixes"
44

5-
exclude: ^.cruft.json|.copier-answers.yml$
5+
exclude: |
6+
(?x)(
7+
^\.github/config.yml$|
8+
)
69
710
repos:
811
- repo: https://github.com/adamchainz/blacken-docs

‎AUTHORS.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Project Authors
2+
3+
The following people have made contributions to the project (in alphabetical
4+
order by last name) and are considered "The samplepackagename Developers":
5+
6+
* [name](https://github.com/<username>) - Institute, Country (ORCID: [<your ORDIC>](https://www.orcid.org/<your ORDIC>))

‎CHANGELOG.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## Unreleased
9+
10+
<!--
11+
Below is an example for a release
12+
13+
## 0.0.1
14+
Released on 2025-06-04
15+
DOI: https://zenodo.org/records/148521
16+
Contributors:
17+
* author1
18+
* author2
19+
20+
### 🚀 Added
21+
22+
- function `function2` for calculating something important.
23+
24+
### ✏️ Changed
25+
26+
- Changed the lower bounds on the pandas dependency from v1.5 to v1.2.
27+
28+
### ⚠️ Deprecated
29+
30+
- marked `function1` as deprecated, used the new `function2` instead.
31+
32+
### ❌ Removed
33+
34+
- removed the previously deprecated `function0`.
35+
36+
### 🐛 Fixed
37+
38+
- fixed a bug in `function1` which cause some error.
39+
40+
### 🛡️ Security
41+
42+
- removed a password from the code.
43+
44+
-->

0 commit comments

Comments
 (0)