Skip to content

Commit

Permalink
Add changelog and update next steps doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rly committed Oct 16, 2023
1 parent 18754e2 commit 07c5372
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions {{ cookiecutter.namespace }}/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Changelog for {{ cookiecutter.namespace }}
4 changes: 4 additions & 0 deletions {{ cookiecutter.namespace }}/NEXTSTEPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ replaced or removed.
8. You may need to modify `pyproject.toml` and re-run `python -m pip install -e .` if you
use any dependencies.

9. Update the `CHANGELOG.md` regularly to document changes to your extension.


## Documenting and Publishing Your Extension to the Community

Expand All @@ -65,6 +67,8 @@ your extension.

7. Add a license file. Permissive licenses should be used if possible. **A [BSD license](https://opensource.org/licenses/BSD-3-Clause) is recommended.**

8. Update the `CHANGELOG.md` to document changes to your extension.

8. Make a release for the extension on GitHub with the version number specified. e.g. if version is {{ cookiecutter.version }}, then this page should exist: https://github.com/{{ github_username_list[0] }}/{{ cookiecutter.namespace }}/releases/tag/{{ cookiecutter.version }} . For instructions on how to make a release on GitHub see [here](https://help.github.com/en/github/administering-a-repository/creating-releases).

9. Publish your updated extension on [PyPI](https://pypi.org/).
Expand Down

0 comments on commit 07c5372

Please sign in to comment.