Skip to content

Commit

Permalink
Update repo url to best-practices
Browse files Browse the repository at this point in the history
  • Loading branch information
cunla committed Dec 15, 2024
1 parent e49585f commit 5cf1f01
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ on: push

env:
# Change these for your project's URLs
PYPI_URL: https://pypi.org/p/django-commons-playground
PYPI_TEST_URL: https://test.pypi.org/p/django-commons-playground
PYPI_URL: https://pypi.org/p/best-practices
PYPI_TEST_URL: https://test.pypi.org/p/best-practices

jobs:

Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Django Commons Playground Code of Conduct

The django-commons-playground project utilizes the [Django Commons Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md).
The best-practices project utilizes the [Django Commons Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

This is an example repository for Django Commons. Some relevant areas to review are:

- GitHub action ([release.yml](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)) for releasing to PyPI
- GitHub action ([release.yml](https://github.com/django-commons/best-practices/blob/main/.github/workflows/release.yml)) for releasing to PyPI
- [Documentation](docs/README.md)
12 changes: 6 additions & 6 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Contributing

Everyone is welcome to contribute to `django-commons-playground`. We strictly
Everyone is welcome to contribute to `best-practices`. We strictly
enforce our [Code of Conduct](../CODE_OF_CONDUCT.md), so please review it before
contributing.

## Getting started

1. [Fork the repository](https://github.com/django-commons/django-commons-playground/fork)
2. Clone your fork of the repository `git clone [email protected]:[YOUR_USERNAME_HERE]/django-commons-playground.git && cd django-commons-playground`
1. [Fork the repository](https://github.com/django-commons/best-practices/fork)
2. Clone your fork of the repository `git clone [email protected]:[YOUR_USERNAME_HERE]/best-practices.git && cd best-practices`
3. Create a venv and activate it `python -m venv venv && source venv/bin/activate`
4. Create a feature branch for your work `git checkout -b relevant-branch-name-here`
5. Implement your changes, run the tests and make a commit to your branch
6. Push your branch to GitHub `git push origin relevant-branch-name-here`
7. Create a [PR on the upstream repo (this repo)](https://github.com/django-commons/django-commons-playground/pulls)
7. Create a [PR on the upstream repo (this repo)](https://github.com/django-commons/best-practices/pulls)

## Architecture

The django-commons-playground is a collection of utility functions with a
The best-practices is a collection of utility functions with a
playground theme. The purpose is to serve as an example to inbound repositories.
Because of that the documentation, pre-commit configuration and GitHub actions
are the most important aspects of the project. The code itself is secondary.
Expand All @@ -31,7 +31,7 @@ Nothing special here!

## Releasing

The repo is configured to [automatically release to PyPI](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)
The repo is configured to [automatically release to PyPI](https://github.com/django-commons/best-practices/blob/main/.github/workflows/release.yml)
when a new tag is pushed to GitHub. This makes use of [PyPI's trusted publishers](https://docs.pypi.org/trusted-publishers/).

### Manual releases
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Installation

This section explains how to install `django-commons-playground` to use within
This section explains how to install `best-practices` to use within
your project. It assumes you have a working installation of Python 3.

1. Create venv/virtualenv (`python -m venv venv`)
2. Activate venv/virtualenv (`source venv/bin/activate`)
3. Install `django-commons-playground` (`pip install django-commons-playground`)
3. Install `best-practices` (`pip install best-practices`)

All together now:

```shell
python -m venv venv
source venv/bin/activate
pip install django-commons-playground
pip install best-practices
```
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ keywords = [
]

[project.urls]
Homepage = "https://github.com/django-commons/django-commons-playground"
Issues = "https://github.com/django-commons/django-commons-playground/issues"
Homepage = "https://github.com/django-commons/best-practices"
Issues = "https://github.com/django-commons/best-practices/issues"

0 comments on commit 5cf1f01

Please sign in to comment.