Skip to content

Commit

Permalink
Merge pull request #120 from hugovk/update-repo-things
Browse files Browse the repository at this point in the history
Update repo things
  • Loading branch information
hugovk authored Mar 5, 2020
2 parents c2be521 + 7d0ec60 commit aaca29f
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 17 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### What did you do?

### What did you expect to happen?

### What actually happened?

### What versions are you using?

* OS:
* Python:
* Humanize:

Please include **code** that reproduces the issue.

The [best reproductions](https://stackoverflow.com/help/minimal-reproducible-example) are [self-contained scripts](https://ericlippert.com/2014/03/05/how-to-debug-small-programs/) with minimal dependencies.

```python
code goes here
```
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Fixes #

Changes proposed in this pull request:

*
*
*
34 changes: 17 additions & 17 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -1,59 +1,59 @@
# Default GitHub labels
- color: d73a4a
name: bug
description: "Something isn't working"
name: bug
- color: cfd3d7
name: duplicate
description: "This issue or pull request already exists"
name: duplicate
- color: a2eeef
name: enhancement
description: "New feature or request"
name: enhancement
- color: 7057ff
name: good first issue
description: "Good for newcomers"
name: good first issue
- color: 008672
name: help wanted
description: "Extra attention is needed"
name: help wanted
- color: e4e669
name: invalid
description: "This doesn't seem right"
name: invalid
- color: d876e3
name: question
description: "Further information is requested"
name: question
- color: ffffff
name: wontfix
description: "This will not be worked on"
name: wontfix

# Keep a Changelog labels
# https://keepachangelog.com/en/1.0.0/
- color: 0e8a16
name: "changelog: Added"
description: "For new features"
name: "changelog: Added"
- color: af99e5
name: "changelog: Changed"
description: "For changes in existing functionality"
name: "changelog: Changed"
- color: FFA500
name: "changelog: Deprecated"
description: "For soon-to-be removed features"
name: "changelog: Deprecated"
- color: 00A800
name: "changelog: Fixed"
description: "For any bug fixes"
name: "changelog: Fixed"
- color: ff0000
name: "changelog: Removed"
description: "For now removed features"
name: "changelog: Removed"
- color: 045aa0
name: "changelog: Security"
description: "In case of vulnerabilities"
name: "changelog: Security"
- color: fbca04
name: "changelog: skip"
description: "Exclude PR from release draft"
name: "changelog: skip"

# Other labels
- color: d0c1ff
name: "needs localisation"
description: "Translations need updating"
name: "needs localisation"
- color: e29673
name: "needs tests"
- color: fbca04
name: testing
description: "Unit tests, linting, CI, etc."
name: testing
64 changes: 64 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Release Checklist

- [ ] Get master to the appropriate code release state.
[Travis CI](https://travis-ci.org/hugovk/humanize) and
[GitHub Actions](https://github.com/jmoiron/humanize/actions) should be running
cleanly for all merges to master.
[![Build Status](https://travis-ci.org/hugovk/humanize.svg?branch=master)](https://travis-ci.org/hugovk/humanize)
[![GitHub Actions status](https://github.com/jmoiron/humanize/workflows/Test/badge.svg)](https://github.com/jmoiron/humanize/actions)

https://github.com/hugovk/pypistats/commit/801ed41823e96e2511444dac4dfceb3bdcb37201#diff-60cd2f42437b5cb3c2c09391a6f4c54a

* [ ] Start from a freshly cloned repo:

```bash
cd /tmp
git clone https://github.com/jmoiron/humanize
cd humanize
```

* [ ] (Optional) Create a distribution and release on **TestPyPI**:

```bash
pip install -U pip setuptools wheel twine keyring
rm -rf build
python3 setup.py sdist --format=gztar bdist_wheel
twine check dist/*
twine upload --repository-url https://test.pypi.org/legacy/ dist/humanize-1.0.0*
```

- [ ] (Optional) Check **test** installation:

```bash
pip uninstall -y humanize
pip install -U -i https://test.pypi.org/simple/ humanize
```

* [ ] Tag with the version number:

```bash
git tag -a 1.0.0 -m "Release 1.0.0"
```

* [ ] Create a distribution and release on **live PyPI**:

```bash
pip install -U pip setuptools wheel twine keyring
rm -rf build
python3 setup.py sdist --format=gztar bdist_wheel
twine check dist/*
twine upload -r pypi dist/humanize-1.0.0*
```

* [ ] Check installation:

```bash
pip uninstall -y humanize
pip install -U humanize
```

* [ ] Push tag:
```bash
git push --tags
```
* [ ] Edit GitHub release: https://github.com/jmoiron/humanize/releases

0 comments on commit aaca29f

Please sign in to comment.