diff --git a/Releasing.md b/Releasing.md deleted file mode 100644 index 0c7ea1e..0000000 --- a/Releasing.md +++ /dev/null @@ -1,11 +0,0 @@ -# Releasing on PyPI - -1. Update the `version` in `pyproject.toml`. We use semantic versioning -2. Create and push pull request branch called `release-x.x.x` -3. At the command line, run `make tag` -4. Go to [tags page](https://github.com/pydanny/dj-notebook/tags), choose the most recent tag, and click `Draft a new release` -5. Click `Generate release notes` and then `Publish release notes` -6. Run `make changelog` -7. Use `git commit --amend` to add the just pulled release notes to the release commit -8. `git push --force` -9. Merge to main \ No newline at end of file diff --git a/contributing.md b/contributing.md deleted file mode 100644 index 4a3a915..0000000 --- a/contributing.md +++ /dev/null @@ -1,48 +0,0 @@ -# Contributing - -## Git workflow - -* Fork the repository -* Make your changes in your fork -* Open a pull request to upstream repository - main branch - -## Development - -Install the package in editable mode with test dependencies: - -```bash -pip install -e '.[test]' -``` - -### Code quality - -Lint to codebase with black and ruff for code formatting and linting: - -```bash -make lint -``` - -### Testing - -```bash -make test -``` - -### Building the project locally - -Go to the project root - -```bash -pip install --upgrade build -python -m build -``` - -Test the project, forcing reinstall if necessary - -```bash -pip install dist/*.whl --force-reinstall -``` - -# Credits - -This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the [simplicity](https://github.com/pydanny/simplicity) project template. diff --git a/docs/contributing.md b/docs/contributing.md index fc531be..4a3a915 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,2 +1,48 @@ -```{include} ../contributing.md -``` \ No newline at end of file +# Contributing + +## Git workflow + +* Fork the repository +* Make your changes in your fork +* Open a pull request to upstream repository - main branch + +## Development + +Install the package in editable mode with test dependencies: + +```bash +pip install -e '.[test]' +``` + +### Code quality + +Lint to codebase with black and ruff for code formatting and linting: + +```bash +make lint +``` + +### Testing + +```bash +make test +``` + +### Building the project locally + +Go to the project root + +```bash +pip install --upgrade build +python -m build +``` + +Test the project, forcing reinstall if necessary + +```bash +pip install dist/*.whl --force-reinstall +``` + +# Credits + +This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the [simplicity](https://github.com/pydanny/simplicity) project template. diff --git a/docs/releasing.md b/docs/releasing.md index 3bff0cf..0c7ea1e 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -1,2 +1,11 @@ -```{include} ../releasing.md -``` \ No newline at end of file +# Releasing on PyPI + +1. Update the `version` in `pyproject.toml`. We use semantic versioning +2. Create and push pull request branch called `release-x.x.x` +3. At the command line, run `make tag` +4. Go to [tags page](https://github.com/pydanny/dj-notebook/tags), choose the most recent tag, and click `Draft a new release` +5. Click `Generate release notes` and then `Publish release notes` +6. Run `make changelog` +7. Use `git commit --amend` to add the just pulled release notes to the release commit +8. `git push --force` +9. Merge to main \ No newline at end of file