Skip to content

Commit ab100f8

Browse files
committed
Bump README
1 parent f6f3efa commit ab100f8

File tree

3 files changed

+45
-14
lines changed

3 files changed

+45
-14
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,7 @@ dmypy.json
130130

131131

132132
# media files
133-
/media
133+
/media
134+
135+
node_modules/
136+
package*.json

README.md

+40-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
1-
# Styleguide-Example
2-
3-
---
4-
5-
## 📢 **The Django Styleguide Survey has ended. Expect results soon.** 📢
6-
7-
1. More about it here - <https://www.hacksoft.io/blog/django-styleguide-survey>.
8-
1. Issue where we track the feedback - <https://github.com/HackSoftware/Django-Styleguide/issues/90>.
9-
10-
---
1+
# Django Styleguide Example
112

123
**Table of contents:**
134

145
<!-- toc -->
156

7+
- [How to ask a question or propose something?](#how-to-ask-a-question-or-propose-something)
8+
- [What is this?](#what-is-this)
9+
- [Structure](#structure)
1610
- [General API Stuff](#general-api-stuff)
1711
* [CORS](#cors)
1812
- [Authentication - JWT](#authentication---jwt)
@@ -39,9 +33,43 @@
3933

4034
---
4135

42-
This project serves as an [example of our styleguide](https://github.com/HackSoftware/Django-Styleguide)
36+
## How to ask a question or propose something?
37+
38+
Few points to navigate yourself:
39+
40+
1. If you have an issue with something related to the Django Styleguide Example - **just open an issue. We will respond.**
41+
1. If you have a general question or suggestion - **just open na issue. We will respond.**
42+
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.**
43+
44+
That's about it ✨
45+
46+
## What is this?
47+
48+
Hello 👋
49+
50+
This projects serves as the following:
51+
52+
1. As an [example of our Django Styleguide](https://github.com/HackSoftware/Django-Styleguide), where people can explore actual code & not just snippets.
53+
1. As a Django project, where we can test various things & concepts. A lot of the things you see here are being used as a foundation of our internal projects at [HackSoft](https://www.hacksoft.io/).
54+
- Usually, this is how something ends up as a section in the [Django Styleguide](https://github.com/HackSoftware/Django-Styleguide)
55+
1. As a place for all code examples from [our blog](https://www.hacksoft.io/blog).
56+
- Code snippets tend to decay & **we want most of our blog articles to be up to date.** That's why we place the code here, write tests for it & guarantee a longer shelf life of the examples.
57+
58+
If you want to learn more about the Django Styleguide, you can watch the videos below:
59+
60+
**Radoslav Georgiev's [Django structure for scale and longevity](https://www.youtube.com/watch?v=yG3ZdxBb1oo) for the philosophy behind the styleguide:**
61+
62+
[![Django structure for scale and longevity by Radoslav Georgiev](https://img.youtube.com/vi/yG3ZdxBb1oo/0.jpg)](https://www.youtube.com/watch?v=yG3ZdxBb1oo)
63+
64+
**Radoslav Georgiev & Ivaylo Bachvarov's [discussion on HackCast, around the Django Styleguide](https://www.youtube.com/watch?v=9VfRaPECbpY):**
65+
66+
[![HackCast S02E08 - Django Community & Django Styleguide](https://img.youtube.com/vi/9VfRaPECbpY/0.jpg)](https://www.youtube.com/watch?v=9VfRaPECbpY)
67+
68+
## Structure
69+
70+
The initial structure was inspired by [cookiecutter-django](https://github.com/pydanny/cookiecutter-django).
4371

44-
The structure is inspired by [cookiecutter-django](https://github.com/pydanny/cookiecutter-django) and modified based on our experience with Django.
72+
**The structure now is modified based on our work & production experince with Django.**
4573

4674
Few important things:
4775

markdown_tools/toc.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44

55
def get_new_toc():
6-
new_toc = check_output("markdown-toc README.md", shell=True).decode("utf-8")
6+
new_toc = check_output("node_modules/.bin/markdown-toc README.md", shell=True).decode("utf-8")
77

88
pattern = ["<!-- toc -->", "", new_toc, "", "<!-- tocstop -->"]
99

0 commit comments

Comments
 (0)