Merge branch 'changes'

Author: weppos

CHANGELOG.md

@@ -91,30 +91,30 @@ FEATURES:
   - Added `reason`, `status` and `response` fields to exceptions
   - Updates the exception string serialization format
 
-## 2.6.0
+## 2.6.0 - 2022-08-17
 
 - CHANGED:
   - Exceptions error messages are displayed correctly ([dnsimple/dnsimple-python#340](https://github.com/dnsimple/dnsimple-python/pull/340))
   - Dependency updates
 
-## 2.5.0
+## 2.5.0 - 2022-07-20
 
 - CHANGED:
   - Deprecate Certificate's `contact_id` (dnsimple/dnsimple-python#314)
   - Dependency updates
 
-## 2.4.0
+## 2.4.0 - 2022-02-16
 
 - CHANGED:
   - Dropped support of Python 3.6
   - Dependency updates
 
-## 2.3.1
+## 2.3.1 - 2022-02-10
 
 - CHANGED:
   - Dependency updates
 
-## 2.3.0
+## 2.3.0 - 2021-10-29
 
 - CHANGED:
   - Dependency updates
@@ -123,37 +123,37 @@ FEATURES:
 - REMOVED:
   - Developer warning in README.md
 
-## 2.2.1
+## 2.2.1 - 2021-07-01
 
 - CHANGED:
   Dependency updates
 
-## 2.2.0
+## 2.2.0 - 2021-05-19
 
 - CHANGED:
   - Feature: Added `registrar.get_domain_prices` to retrieve whether a domain is premium and the prices to register, transfer, and renew. (dnsimple/dnsimple-python#174)
   - Deprecated: get_domain_premium_price, use get_domain_prices instead.
   - Dependency updates
 
-## 2.1.2
+## 2.1.2 - 2021-05-10
 
 - CHANGED:
   Dependencies updates with a security update for urllib3
 
-## 2.1.1
+## 2.1.1 - 2021-02-24
 
 - CHANGED:
   Dependencies update
   Fixed #98
 
-## 2.1.0
+## 2.1.0 - 2020-12-31
 
 - CHANGED: Dependencies update
 
-## 2.0.1
+## 2.0.1 - 2020-11-12
 
 - CHANGED: Dependencies update
 
-## 2.0.0
+## 2.0.0 - 2020-09-28
 
 Adopted public release.

CONTRIBUTING.md

@@ -40,38 +40,12 @@ To run the test suite:
 make test
 ```
 
-## Releasing
+## Changelog
 
-The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.
-
-1. Set the version in `./dnsimple/version.py` and `pyproject.toml`.
-
-    ```python
-    version = "$VERSION"
-    ```
-
-2. Run the test suite and ensure all tests pass: `make test`
-
-3. Finalize the `## main` section in `CHANGELOG.md` assigning the version.
-
-4. Commit and push the changes
-
-    ```shell
-    git commit -s -a -m "Release $VERSION"
-    git push origin main
-    ```
-
-5. Wait for CI to complete.
-
-6. Create a signed tag.
-
-    ```shell
-    git tag -a v$VERSION -s -m "Release $VERSION"
-    git push origin --tags
-    ```
+We follow the [Common Changelog](https://common-changelog.org/) format for changelog entries.
 
 ## Testing
 
 Submit unit tests for your changes. You can test your changes on your machine by [running the test suite](#testing).
 
-When you submit a PR, tests will also be run on the [continuous integration environment via Travis](https://travis-ci.com/dnsimple/dnsimple-python).
+When you submit a PR, tests will also be run on the [continuous integration environment via GitHub Actions](https://github.com/dnsimple/dnsimple-python/actions).

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2025 DNSimple Corporation
+Copyright (c) 2024-2026 DNSimple Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -139,8 +139,12 @@ For example, if you use `my-app`, the final header value will be `my-app dnsimpl
 
 ## Contributing
 
-Contibutions are welcomed. Please open an issue to discuss the changes before opening a PR. For more details on how to do development please refer to [CONTRIBUTING.md](CONTRIBUTING.md)
+Contributions are welcome! Please feel free to submit issues and pull requests. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
 
 ## License
 
-Copyright (c) 2025 DNSimple Corporation. This is Free Software distributed under the MIT license.
+Copyright (c) 2024-2026 DNSimple Corporation. This is Free Software distributed under the [MIT License](LICENSE.txt).

RELEASING.md

@@ -0,0 +1,67 @@
+# Releasing
+
+This document describes the steps to release a new version of DNSimple/Python.
+
+## Prerequisites
+
+- You have commit access to the repository
+- You have push access to the repository
+- You have a GPG key configured for signing tags
+- You have permission to publish to PyPI
+
+## Release process
+
+1. **Determine the new version** using [Semantic Versioning](https://semver.org/)
+
+   ```shell
+   VERSION=X.Y.Z
+   ```
+
+   - **MAJOR** version for incompatible API changes
+   - **MINOR** version for backwards-compatible functionality additions
+   - **PATCH** version for backwards-compatible bug fixes
+
+2. **Update the version files** with the new version
+
+   Edit `./dnsimple/version.py` and `pyproject.toml`:
+
+   ```python
+   version = "$VERSION"
+   ```
+
+3. **Run tests** and confirm they pass
+
+   ```shell
+   make test
+   ```
+
+4. **Update the changelog** with the new version
+
+   Finalize the `## main` section in `CHANGELOG.md` assigning the version.
+
+5. **Commit the new version**
+
+   ```shell
+   git commit -a -m "Release $VERSION"
+   ```
+
+6. **Push the changes**
+
+   ```shell
+   git push origin main
+   ```
+
+7. **Wait for CI to complete**
+
+8. **Create a signed tag**
+
+   ```shell
+   git tag -a v$VERSION -s -m "Release $VERSION"
+   git push origin --tags
+   ```
+
+## Post-release
+
+- Verify the new version appears on [PyPI](https://pypi.org/project/dnsimple/)
+- Verify the GitHub release was created
+- Announce the release if necessary