mirror of
https://github.com/HackSoftware/Django-Styleguide.git
synced 2024-11-10 19:56:40 +03:00
Merge pull request #123 from HackSoftware/readme/quick-update
Update README
This commit is contained in:
commit
d11b543531
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -35,6 +35,7 @@ build/Release
|
|||
# Dependency directories
|
||||
node_modules/
|
||||
jspm_packages/
|
||||
package*.json
|
||||
|
||||
# TypeScript v1 declaration files
|
||||
typings/
|
||||
|
|
32
README.md
32
README.md
|
@ -1,18 +1,10 @@
|
|||
![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:**
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [How to ask a question or propose something?](#how-to-ask-a-question-or-propose-something)
|
||||
- [What is this?](#what-is-this)
|
||||
- [How to use it?](#how-to-use-it)
|
||||
- [Overview](#overview)
|
||||
|
@ -74,11 +66,21 @@
|
|||
- [DX (Developer Experience)](#dx-developer-experience)
|
||||
* [`mypy` / type annotations](#mypy--type-annotations)
|
||||
- [Django Styleguide in the Wild](#django-styleguide-in-the-wild)
|
||||
- [Additional resources](#additional-resources)
|
||||
- [Additional resources / Alternatives](#additional-resources--alternatives)
|
||||
- [Inspiration](#inspiration)
|
||||
|
||||
<!-- 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?
|
||||
|
||||
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)
|
||||
|
||||
**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?
|
||||
|
||||
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)
|
||||
- [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
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ from subprocess import check_output
|
|||
|
||||
def get_new_toc():
|
||||
new_toc = check_output(
|
||||
'markdown-toc README.md',
|
||||
'node_modules/.bin/markdown-toc README.md',
|
||||
shell=True
|
||||
).decode('utf-8')
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user