mirror of
https://github.com/kennethreitz-archive/conductofcode.git
synced 2026-06-05 23:30:19 +00:00
explanation
This commit is contained in:
Vendored
+1
-1
@@ -1,4 +1,4 @@
|
||||
<h1>Conduct of Code.</h1>
|
||||
<h1></h1>
|
||||
<p>
|
||||
This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.
|
||||
</p>
|
||||
|
||||
Vendored
+2
-1
@@ -1,4 +1,5 @@
|
||||
<h1><a href="http://python-guide.org">Python Guide.</a></h1>
|
||||
<h1><a href="http://conductofcode.org">Conduct of Code.</a></h1>
|
||||
|
||||
<p>
|
||||
This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.
|
||||
</p>
|
||||
|
||||
Vendored
+3
@@ -95,6 +95,9 @@ div.sphinxsidebarwrapper p.logo {
|
||||
margin: -10px 0 0 -20px;
|
||||
text-align: center;
|
||||
}
|
||||
div.sphinxsidebarwrapper h1 {
|
||||
font-size: 25px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3,
|
||||
div.sphinxsidebar h4 {
|
||||
|
||||
+24
-3
@@ -1,7 +1,9 @@
|
||||
Act I: Id
|
||||
---------
|
||||
|
||||
This part of the guide focuses on...
|
||||
*Id* is the set of uncoordinated instinctual trends in the human psyche.
|
||||
|
||||
This part of the guide focuses on the philosophy behind great code.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -15,7 +17,9 @@ This part of the guide focuses on...
|
||||
Act II: Ego
|
||||
-----------
|
||||
|
||||
This part of the guide focuses on best practices for writing code.
|
||||
*Ego* is the organized and realistic role of the human psyche.
|
||||
|
||||
This part of the guide focuses on best practices for organizing and writing code.
|
||||
|
||||
- obvious benefit (constraints foster creativity)
|
||||
- lawyer up
|
||||
@@ -26,6 +30,10 @@ This part of the guide focuses on best practices for writing code.
|
||||
Act III: Super-ego
|
||||
------------------
|
||||
|
||||
*Super-ego* is the critical and moralizing role of the human psyche.
|
||||
|
||||
This part of the guide focuses on the ethos of great code communities.
|
||||
|
||||
- Clarity is Key
|
||||
- Documentation
|
||||
- Community
|
||||
@@ -33,7 +41,20 @@ Act III: Super-ego
|
||||
- Code of Conduct
|
||||
|
||||
|
||||
--------------------------------------
|
||||
--------------------
|
||||
|
||||
|
||||
Appendix A: Resources
|
||||
---------------------
|
||||
|
||||
For further reading...
|
||||
|
||||
- Semantic Versioning
|
||||
- The Architecture of Open Source Applications
|
||||
- *&c*
|
||||
|
||||
Appendix B: Meta
|
||||
----------------
|
||||
|
||||
Contibution notes and legal information are here (for those interested).
|
||||
|
||||
|
||||
+2
-5
@@ -1,5 +1,5 @@
|
||||
The Conduct of Code
|
||||
===================
|
||||
Conduct of Code, *a Manifesto*.
|
||||
===============================
|
||||
|
||||
In our busy lives, we have to take time to reflect. It's easy to forget why we code.
|
||||
|
||||
@@ -12,7 +12,4 @@ Great code is craft — a reflection of the person creating it.
|
||||
|
||||
Let's focus on why.
|
||||
|
||||
|
||||
|
||||
|
||||
.. include:: contents.rst.inc
|
||||
Reference in New Issue
Block a user