Skip to content

Commit c0253dd

Browse files
datapythonistadatapythonista
committed
Adding dashboard for the pandas sprint
1 parent ee7307c commit c0253dd

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

‎pandas/dashboard.html‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
8+
<title>#pandasSprint</title>
9+
10+
<!-- Bootstrap -->
11+
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" rel="stylesheet">
12+
13+
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
14+
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
15+
<!--[if lt IE 9]>
16+
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
17+
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
18+
<![endif]-->
19+
<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
20+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
21+
<!-- Include all compiled plugins (below), or include individual files as needed -->
22+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js"></script>
23+
</head>
24+
<body>
25+
<div class="row">
26+
<div class="col-lg-6">
27+
<h1>#pandasSprint overview</h1>
28+
<ol>
29+
<li><a href="https://python-sprints.github.io/pandas/guide/pandas_setup.html">Install the environment</a></li>
30+
<li>Your local organizers will assign you a documentation page</li>
31+
<li>
32+
Understand <b>well</b> what the functionality you're documenting does
33+
<ul>
34+
<li>Check the current <a href="https://pandas.pydata.org/pandas-docs/stable/">pandas documentation</a></li>
35+
<li>Search <a href="https://stackoverflow.com">Stack overflow</a> for it</li>
36+
<li>Use a jupyter notebook to experiment</li>
37+
</ul>
38+
</li>
39+
<li>Find where the docstring is in the source code</li>
40+
<li>
41+
Check if the docstring is reused by other functions/methods
42+
<ul>
43+
<li>You have a <a href="https://github.com/TomAugspurger/pandas/blob/0e43660d96d4f4d8f860643fc1271a603ad2390c/doc/source/contributing.rst#sharing-docstrings">guide about sharing docstrings</a></li>
44+
<li>If it is, <a href="https://docs.google.com/spreadsheets/d/10EpQFkVDqiIFLLVGtIWzCMRACz20yWuta3_DU0qV6-E/edit#gid=861430795">investigate</a> who is working in the other functions<li>
45+
<li>Contact them to make sure you don't have code conflicts, or you do repeated work</li>
46+
</ul>
47+
</li>
48+
<li>
49+
Follow <b>carefully</b> the <a href="https://python-sprints.github.io/pandas/guide/pandas_docstring.html">instructions on how to write a good docstring</a>
50+
<ul>
51+
<li>Every detail is important</li>
52+
<li>Doing it fast will make the process slower, and you will waste reviewers time</li>
53+
<li>The changes will only get approved when they are <b>perfect</b></li>
54+
</ul>
55+
</li>
56+
<li>Run the <a href="https://python-sprints.github.io/pandas/guide/pandas_pr.html#validate-that-your-docstring-does-not-have-technical-errors">validation script</a>, and make sure you don't have errors</li>
57+
<li><a href="https://python-sprints.github.io/pandas/guide/pandas_pr.html#visual-validation-of-the-docstring">Build the html version</a> of the documentation</li>
58+
<li>Show the html version to someone in your sprint who has not work on it
59+
<ul>
60+
<li>Does this person understand what the function does, and is able to use it in a toy example?</li>
61+
<li>Is everything explained in a clear way? Is there any part that is not well understood?</li>
62+
<li>Is the language correct? Are there grammar mistakes or typos?</li>
63+
<li>Can the page be simplified? Is there anything that doesn't add value?</li>
64+
<li>Checking the text version of the docstring, does it follow all the standards from the documentation?</li>
65+
</ul>
66+
</li>
67+
<li>Validate that there are no PEP-8 issues <code>git diff upstream/master -u -- "*.py" | flake8 --diff</code></li>
68+
<li><a href="https://python-sprints.github.io/pandas/guide/pandas_pr.html#commit-your-changes">Commit and push</a> your changes</li>
69+
<li>Open the pull request
70+
<ul>
71+
<li>Make sure the description is <code>DOC: Improved the docstring of &lt;your-function&gt;</code></li>
72+
<li>Review if you did all the validations enumerated in the description</li>
73+
<li>Mark them with <code>[X]</code> if you did, do the validation <b>before</b> sending the PR if you didn't</li>
74+
<li><b>If you completed EVERY step in this list, you can finally open the PR</b></li>
75+
</ul>
76+
</li>
77+
<li>Now you can take a rest, help other people, make new friends... :)</li>
78+
<li>Your PR will be reviewed by other people, who will help make it even better
79+
<ul>
80+
<li>Make the changes and discuss the PR until it's approved</li>
81+
</ul>
82+
</li>
83+
<li>You should also review <a href="https://github.com/pandas-dev/pandas/pulls">other people PRs</a>
84+
<ul>
85+
<li>Be nice, concise and clear</li>
86+
<li>In general it's better of avoid comments in a PR with only "Thank you", "Understood", "I'll do it"...</li>
87+
</ul>
88+
</li>
89+
</ol>
90+
</div>
91+
<div class="col-lg-6">
92+
<a class="twitter-timeline" href="https://twitter.com/hashtag/pandasSprint" data-widget-id="972275233502703616">#pandasSprint Tweets</a>
93+
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
94+
95+
</div>
96+
</div>
97+
</body>
98+
</html>

0 commit comments

Comments
 (0)