-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
15 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters