Skip to content

Commit 40dd3e6

Browse files
authored
Merge branch 'master' into feature/fix-git-section-redirections
2 parents 4676f95 + d69a143 commit 40dd3e6

23 files changed

+677
-14
lines changed

.env.dist

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
GH_TOKEN=

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,6 @@ _book
1313
# eBook build output
1414
*.epub
1515
*.mobi
16-
*.pdf
16+
*.pdf
17+
18+
.env

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ We accept recommendations from all enthusiastic who care about the quality. The
1212
* [Git](../git/)
1313
* [Java](../java/)
1414
* [PHP](../php/)
15+
* [Python](../python/)
1516
* [VueJS](../vuejs/)
1617

1718
## Contributions

SUMMARY.md

100755100644
Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* [Branch Naming](git/branch-naming.md)
1616
* [Commit Message Naming](git/commit-message-naming.md)
1717
* [Pull Request Naming](git/pull-request-naming.md)
18+
* [Tag Naming](git/tag-naming.md)
1819
* [Java](java/README.md)
1920
* [Class Naming](java/class-naming.md)
2021
* [Interface Naming](java/interface-naming.md)
@@ -37,4 +38,14 @@
3738
* [Templates components Naming](vuejs/templates-components-naming.md)
3839
* [Constants naming](vuejs/constants-naming.md)
3940
* [Method Naming](vuejs/method-naming.md)
40-
* [Variable Naming](vuejs/variable-naming.md)
41+
* [Variable Naming](vuejs/variable-naming.md)
42+
* [Python](python/README.md)
43+
* [Class Naming](python/class-naming.md)
44+
* [Module Naming](python/module-naming.md)
45+
* [Method Naming](python/method-naming.md)
46+
* [Variable Naming](python/variable-naming.md)
47+
* [Constant Naming](python/constant-naming.md)
48+
* [Package Naming](python/file-naming.md)
49+
* [Exception( Error ) Naming](python/exception-naming.md)
50+
* [Underscore](python/underscore.md)
51+

_layouts/website/page.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,5 +109,16 @@
109109
});
110110
}
111111
</script>
112+
113+
<!-- Global site tag (gtag.js) - Google Analytics -->
114+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-138722543-1"></script>
115+
<script>
116+
window.dataLayer = window.dataLayer || [];
117+
function gtag(){dataLayer.push(arguments);}
118+
gtag('js', new Date());
119+
120+
gtag('config', 'UA-138722543-1');
121+
</script>
122+
112123
</div>
113124
{% endblock %}

book.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
"github-edit",
55
"sitemap-general",
66
"smart-nav-collapse",
7-
"githubcontributors"
7+
"githubcontributors",
8+
"link-fix",
9+
"contributors-each-page"
810
],
911
"pluginsConfig": {
1012
"github-edit": {
@@ -18,6 +20,12 @@
1820
"githubOwner": "naming-convention",
1921
"githubRepository": "naming-convention-guides",
2022
"contributorWidth": "40px"
23+
},
24+
"contributors-each-page": {
25+
"owner": "naming-convention",
26+
"repository": "naming-convention-guides",
27+
"title": "Contributors",
28+
"excluded": ["README.md"]
2129
}
2230
},
2331
"styles": {

docs/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Please follow recommended workflow below:
3434
1. Please fork this repo and send pull requests.
3535
2. For minor edits, you edit pages using Github's web-based editor.
3636
3. For major edits, it will be better to make a pull request or use [gitbook-editor](https://legacy.gitbook.com/editor) on localhost.
37-
4. It will be useful to check [gitbook help docs](http://help.gitbook.io/). Not all docs may be useful to you.
37+
4. It will be useful to check [gitbook help docs](https://help.gitbook.com/). Not all docs may be useful to you.
3838

3939
Please feel free to open a [github issue](https://github.com/wpveda/book/issues) if you need more help.
4040

@@ -50,4 +50,4 @@ Please feel free to open a [github issue](https://github.com/wpveda/book/issues)
5050
**Gitbook Editor**
5151

5252
1. For offline editing - desktop tool gitbook editor can be used - [https://legacy.gitbook.com/editor/releases](https://legacy.gitbook.com/editor/releases)
53-
2. Once you download Gitbook editor, open the repo folder from your forked & locally cloned git repo.
53+
2. Once you download Gitbook editor, open the repo folder from your forked & locally cloned git repo.

git/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
# Git Naming Convention
22
List of covered sections:
33
* [Branch Naming](../git/branch-naming.md)
4-
<<<<<<< Updated upstream
5-
* [Commit Message Naming](../java/commit-message-naming.md)
6-
* [Pull Request Naming](../java/pull-request-naming.md)
7-
=======
84
* [Commit Message Naming](../git/commit-message-naming.md)
95
* [Pull Request Naming](../git/pull-request-naming.md)
106
* [Tag Naming](../git/tag-naming.md)
11-
>>>>>>> Stashed changes
127

138
Missing something? Please contribute here by reading [this guide](../docs/CONTRIBUTING.md).

git/commit-message-naming.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,17 @@ Example:
2626
Implement proper authorization for each service on development phase to validate during the API call.
2727
2828
Access right management is used to check proper authorization to access an API by an employee or the employer.
29-
```
29+
```
30+
31+
## Conventional Commits
32+
33+
Commit messages **MAY** use [Conventional Commits](https://www.conventionalcommits.org/en/) format. It provides guidelines to create a better commit history log, making easier to have automated tasks around it (e.g. automated changelogs). Commits would follow the format `<type>[optional scope]: <description>`, where `<type>` might be `feat`/`fix`/`chore`/`docs` etc. and breaking changes are indicated on the beginning of the optional body or footer section.
34+
35+
Example:
36+
```
37+
git commit -m "feat(survey): add nps survey to the home page
38+
39+
BREAKING CHANGE: `survey` objects in xml file have been re-used in the global configurations.
40+
```
41+
42+
Please refer to [Conventional Commits docs](https://www.conventionalcommits.org/en/) for more details

git/tag-naming.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Git Naming Convention > Tag Naming
2+
3+
May:
4+
- Use [Semantic Versioning](https://semver.org/)
5+
- Prefix the version number with the letter *v*
6+
7+
Suggested Formats:
8+
- With prefix *{vX.Y.Z}*
9+
- Without prefix *{X.Y.Z}*
10+
11+
Example:
12+
```git
13+
git tag -a 1.0.2 // or optionally v1.0.2
14+
```

0 commit comments

Comments
 (0)