You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The django-commons-playground project utilizes the [Django Commons Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md).
3
+
The best-practices project utilizes the [Django Commons Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md).
Copy file name to clipboardExpand all lines: README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,5 +2,5 @@
2
2
3
3
This is an example repository for Django Commons. Some relevant areas to review are:
4
4
5
-
- GitHub action ([release.yml](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)) for releasing to PyPI
5
+
- GitHub action ([release.yml](https://github.com/django-commons/best-practices/blob/main/.github/workflows/release.yml)) for releasing to PyPI
Copy file name to clipboardExpand all lines: docs/contributing.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,22 @@
1
1
# Contributing
2
2
3
-
Everyone is welcome to contribute to `django-commons-playground`. We strictly
3
+
Everyone is welcome to contribute to `best-practices`. We strictly
4
4
enforce our [Code of Conduct](../CODE_OF_CONDUCT.md), so please review it before
5
5
contributing.
6
6
7
7
## Getting started
8
8
9
-
1.[Fork the repository](https://github.com/django-commons/django-commons-playground/fork)
10
-
2. Clone your fork of the repository `git clone [email protected]:[YOUR_USERNAME_HERE]/django-commons-playground.git && cd django-commons-playground`
9
+
1.[Fork the repository](https://github.com/django-commons/best-practices/fork)
10
+
2. Clone your fork of the repository `git clone [email protected]:[YOUR_USERNAME_HERE]/best-practices.git && cd best-practices`
11
11
3. Create a venv and activate it `python -m venv venv && source venv/bin/activate`
12
12
4. Create a feature branch for your work `git checkout -b relevant-branch-name-here`
13
13
5. Implement your changes, run the tests and make a commit to your branch
14
14
6. Push your branch to GitHub `git push origin relevant-branch-name-here`
15
-
7. Create a [PR on the upstream repo (this repo)](https://github.com/django-commons/django-commons-playground/pulls)
15
+
7. Create a [PR on the upstream repo (this repo)](https://github.com/django-commons/best-practices/pulls)
16
16
17
17
## Architecture
18
18
19
-
The django-commons-playground is a collection of utility functions with a
19
+
The best-practices is a collection of utility functions with a
20
20
playground theme. The purpose is to serve as an example to inbound repositories.
21
21
Because of that the documentation, pre-commit configuration and GitHub actions
22
22
are the most important aspects of the project. The code itself is secondary.
@@ -31,7 +31,7 @@ Nothing special here!
31
31
32
32
## Releasing
33
33
34
-
The repo is configured to [automatically release to PyPI](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)
34
+
The repo is configured to [automatically release to PyPI](https://github.com/django-commons/best-practices/blob/main/.github/workflows/release.yml)
35
35
when a new tag is pushed to GitHub. This makes use of [PyPI's trusted publishers](https://docs.pypi.org/trusted-publishers/).
0 commit comments