You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"announcement": "<p><a href='https://www.pyopensci.org/software-peer-review/about/intro.html'>Submit Your Python Package for Peer Review - Learn More!</a></p>🚧 This guide is currently being developed! 🚧 ",
62
+
#"navbar_center": ["nav"], this can be a way to override the default navigation structure
55
63
"external_links": [
56
64
{
57
65
"url": "https://www.pyopensci.org",
@@ -74,17 +82,19 @@
74
82
},
75
83
],
76
84
"logo": {
77
-
"text": "Python Package Guide",
85
+
"text": "Python Packaging",
78
86
"image_dark": "logo-dark-mode.png",
79
87
"image_light": "logo-light-mode.png",
80
88
"alt_text": "pyOpenSci Python Package Guide. The pyOpenSci logo is a purple flower with pyOpenSci under it. The o in open sci is the center of the flower",
81
89
},
82
-
"header_links_before_dropdown": 3,
90
+
"header_links_before_dropdown": 4,
83
91
"use_edit_page_button": True,
92
+
"show_nav_level": 2,
93
+
"navigation_depth": 3,
84
94
"show_toc_level": 1,
85
95
# "navbar_align": "left", # [left, content, right] For testing that the navbar items align properly
Your package should have a **CODE_OF_CONDUCT.md** file located
10
+
Your package should have a `CODE_OF_CONDUCT.md` file located
11
11
the root of the repository. Once you have people using your
12
12
package, you can consider the package itself as having a community
13
13
around it. Some of this community uses your tool. These users
@@ -17,20 +17,20 @@ Others in the community might want to contribute to your tool.
17
17
They might fix bugs, update documentation and engage with the
18
18
maintainer team.
19
19
20
-
## Why you need a code of conduct
20
+
## Why you need a CODE_OF_CONDUCT
21
21
22
22
In order to keep this community healthy and to protect yourself,
23
-
your mainatianer team and your users from unhealthy behavior,
24
-
it is important to have a [code of conduct](https://opensource.guide/code-of-conduct/).
23
+
your maintainer team and your users from unhealthy behavior,
24
+
it is important to have a [`CODE_OF_CONDUCT`](https://opensource.guide/code-of-conduct/).
25
25
26
-
The code of conduct is important
26
+
The `CODE_OF_CONDUCT` is important
27
27
as it establishes what you expect in terms of how users and
28
28
contributors interact with maintainers and each other. It also
29
29
establishes rules and expectations which can then be enforced
30
-
if need be to protect others from harmful and/or negative behaviors.
30
+
if need be to protect others from harmful and/or negative behaviors.
31
31
32
32
If you are not comfortable
33
-
with creating your own code of conduct text, we encourage you to adopt the
34
-
code of conduct language used in the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
35
-
[Many other communities](https://www.contributor-covenant.org/adopters/) have adopted this code of conduct as
33
+
with creating your own `CODE_OF_CONDUCT` text, we encourage you to adopt the
34
+
`CODE_OF_CONDUCT` language used in the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
35
+
[Many other communities](https://www.contributor-covenant.org/adopters/) have adopted this `CODE_OF_CONDUCT` as
36
36
their own. See the [Fatiando a Terra Geoscience Python community's example here.](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)
0 commit comments