Update README

- Remove the banner about the survey feedback
- Add additional resources
This commit is contained in:
Radoslav Georgiev 2023-02-02 16:07:39 +02:00
parent b6591fe7ff
commit 155cb7b598
3 changed files with 22 additions and 13 deletions

1
.gitignore vendored
View File

@ -35,6 +35,7 @@ build/Release
# Dependency directories # Dependency directories
node_modules/ node_modules/
jspm_packages/ jspm_packages/
package*.json
# TypeScript v1 declaration files # TypeScript v1 declaration files
typings/ typings/

View File

@ -1,18 +1,10 @@
![Django Styleguide](logo.png) ![Django Styleguide](logo.png)
---
## 📢 **The Django Styleguide Survey has ended. Expect results soon.** 📢
1. More about it here - <https://www.hacksoft.io/blog/django-styleguide-survey>.
1. Issue where we track the feedback - <https://github.com/HackSoftware/Django-Styleguide/issues/90>.
---
**Table of contents:** **Table of contents:**
<!-- toc --> <!-- toc -->
- [How to ask a question or propose something?](#how-to-ask-a-question-or-propose-something)
- [What is this?](#what-is-this) - [What is this?](#what-is-this)
- [How to use it?](#how-to-use-it) - [How to use it?](#how-to-use-it)
- [Overview](#overview) - [Overview](#overview)
@ -74,11 +66,21 @@
- [DX (Developer Experience)](#dx-developer-experience) - [DX (Developer Experience)](#dx-developer-experience)
* [`mypy` / type annotations](#mypy--type-annotations) * [`mypy` / type annotations](#mypy--type-annotations)
- [Django Styleguide in the Wild](#django-styleguide-in-the-wild) - [Django Styleguide in the Wild](#django-styleguide-in-the-wild)
- [Additional resources](#additional-resources) - [Additional resources / Alternatives](#additional-resources--alternatives)
- [Inspiration](#inspiration) - [Inspiration](#inspiration)
<!-- tocstop --> <!-- tocstop -->
## How to ask a question or propose something?
Few points to navigate yourself:
1. If you've read the Django Styleguide & you have questions or suggestions, **the simplest thing you can is to open an issue.** We will respond.
1. Even if you have a question that you are not sure if it's related to the Django Styleguide - **just open an issue anyway.** We will respond.
1. **If you want to see a code example**, make sure to head to the [Django Styleguide Example](https://github.com/HackSoftware/Django-Styleguide-Example) repository. We treat this as a "Django test project", combining best practices & also [examples from our blog](https://www.hacksoft.io/blog).
That's about it ✨
## What is this? ## What is this?
Hello 👋 Hello 👋
@ -97,6 +99,10 @@ This is the Django Styleguide, created by us, the folks at [HackSoft](https://ha
[![Django structure for scale and longevity by Radoslav Georgiev](https://img.youtube.com/vi/yG3ZdxBb1oo/0.jpg)](https://www.youtube.com/watch?v=yG3ZdxBb1oo) [![Django structure for scale and longevity by Radoslav Georgiev](https://img.youtube.com/vi/yG3ZdxBb1oo/0.jpg)](https://www.youtube.com/watch?v=yG3ZdxBb1oo)
**You can also watch Radoslav Georgiev & Ivaylo Bachvarov's [discussion on HackCast, around the Django Styleguide](https://www.youtube.com/watch?v=9VfRaPECbpY):**
[![HackCast S02E08 - Django Community & Django Styleguide](https://img.youtube.com/vi/9VfRaPECbpY/0.jpg)](https://www.youtube.com/watch?v=9VfRaPECbpY)
## How to use it? ## How to use it?
When it comes to the Django Styleguide, **there are 3 general ways of using it:** When it comes to the Django Styleguide, **there are 3 general ways of using it:**
@ -2760,11 +2766,13 @@ Here's a collection of different folks & companies, that have found the stylegui
--- ---
## Additional resources ## Additional resources / Alternatives
Additional resources that we found useful and that can add value to the styleguide. Additional resources & other alternatives that we found useful and that can add value to the styleguide.
- [Dan Palmer - Scaling Django to 500 apps (DjangoCon US 2021)](https://www.youtube.com/watch?v=NsHo-kThlqI) - [Dan Palmer - Scaling Django to 500 apps (DjangoCon US 2021)](https://www.youtube.com/watch?v=NsHo-kThlqI)
- [Django API Domains](https://phalt.github.io/django-api-domains/)
- [A YC News discussion around the Django Styleguide](https://news.ycombinator.com/item?id=34337667) - you can potentially find additional useful things here.
## Inspiration ## Inspiration

View File

@ -4,7 +4,7 @@ from subprocess import check_output
def get_new_toc(): def get_new_toc():
new_toc = check_output( new_toc = check_output(
'markdown-toc README.md', 'node_modules/.bin/markdown-toc README.md',
shell=True shell=True
).decode('utf-8') ).decode('utf-8')