Skip to content

Commit

Permalink
Move files to their true places
Browse files Browse the repository at this point in the history
  • Loading branch information
pydanny committed Sep 29, 2023
1 parent 17afb92 commit 622691e
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 63 deletions.
11 changes: 0 additions & 11 deletions Releasing.md

This file was deleted.

48 changes: 0 additions & 48 deletions contributing.md

This file was deleted.

50 changes: 48 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,48 @@
```{include} ../contributing.md
```
# 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.
13 changes: 11 additions & 2 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
```{include} ../releasing.md
```
# 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

0 comments on commit 622691e

Please sign in to comment.