|
20 | 20 | <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> |
21 | 21 | <!-- Include all compiled plugins (below), or include individual files as needed --> |
22 | 22 | <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js"></script> |
| 23 | + <style> |
| 24 | + input { |
| 25 | + margin-right: 5px; |
| 26 | + } |
| 27 | + </style> |
23 | 28 | </head> |
24 | 29 | <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> |
| 30 | + <div class="row" style="margin-top: 10px;"> |
| 31 | + <div class="col-lg-8"> |
| 32 | + <h1 style="margin-left: 30px;">#pandasSprint</h1> |
| 33 | + <ol style="margin-left: 30px;"> |
| 34 | + <li><input type="checkbox"><a href="https://python-sprints.github.io/pandas/guide/pandas_setup.html">Install the environment</a></li> |
| 35 | + <li><input type="checkbox">Your local organizers will assign you a documentation page</li> |
| 36 | + <li><input type="checkbox"> |
32 | 37 | Understand <b>well</b> what the functionality you're documenting does |
33 | 38 | <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> |
| 39 | + <li><input type="checkbox">Check the current <a href="https://pandas.pydata.org/pandas-docs/stable/">pandas documentation</a></li> |
| 40 | + <li><input type="checkbox">Search <a href="https://stackoverflow.com">Stack overflow</a> for it</li> |
| 41 | + <li><input type="checkbox">Use a jupyter notebook to experiment</li> |
37 | 42 | </ul> |
38 | 43 | </li> |
39 | | - <li>Find where the docstring is in the source code</li> |
40 | | - <li> |
| 44 | + <li><input type="checkbox">Find where the docstring is in the source code</li> |
| 45 | + <li><input type="checkbox"> |
41 | 46 | Check if the docstring is reused by other functions/methods |
42 | 47 | <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> |
| 48 | + <li><input type="checkbox">You have a <a href="https://github.com/TomAugspurger/pandas/blob/0e43660d96d4f4d8f860643fc1271a603ad2390c/doc/source/contributing.rst#sharing-docstrings">guide about sharing docstrings</a></li> |
| 49 | + <li><input type="checkbox">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> |
| 50 | + <li><input type="checkbox">Contact them to make sure you don't have code conflicts, or you do repeated work</li> |
46 | 51 | </ul> |
47 | 52 | </li> |
48 | | - <li> |
| 53 | + <li><input type="checkbox"> |
49 | 54 | 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 | 55 | <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> |
| 56 | + <li><input type="checkbox">Every detail is important</li> |
| 57 | + <li><input type="checkbox">Doing it fast will make the process slower, and you will waste reviewers time</li> |
| 58 | + <li><input type="checkbox">The changes will only get approved when they are <b>perfect</b></li> |
54 | 59 | </ul> |
55 | 60 | </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 |
| 61 | + <li><input type="checkbox">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> |
| 62 | + <li><input type="checkbox"><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> |
| 63 | + <li><input type="checkbox">Show the html version to someone in your sprint who has not work on it |
59 | 64 | <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 | + <li><input type="checkbox">Does this person understand what the function does, and is able to use it in a toy example?</li> |
| 66 | + <li><input type="checkbox">Is everything explained in a clear way? Is there any part that is not well understood?</li> |
| 67 | + <li><input type="checkbox">Is the language correct? Are there grammar mistakes or typos?</li> |
| 68 | + <li><input type="checkbox">Can the page be simplified? Is there anything that doesn't add value?</li> |
| 69 | + <li><input type="checkbox">Checking the text version of the docstring, does it follow all the standards from the documentation?</li> |
65 | 70 | </ul> |
66 | 71 | </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 |
| 72 | + <li><input type="checkbox">Validate that there are no PEP-8 issues <code>git diff upstream/master -u -- "*.py" | flake8 --diff</code></li> |
| 73 | + <li><input type="checkbox"><a href="https://python-sprints.github.io/pandas/guide/pandas_pr.html#commit-your-changes">Commit and push</a> your changes</li> |
| 74 | + <li><input type="checkbox">Open the pull request |
70 | 75 | <ul> |
71 | | - <li>Make sure the description is <code>DOC: Improved the docstring of <your-function></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> |
| 76 | + <li><input type="checkbox">Make sure the description is <code>DOC: Improved the docstring of <your-function></code></li> |
| 77 | + <li><input type="checkbox">Review if you did all the validations enumerated in the description</li> |
| 78 | + <li><input type="checkbox">Mark them with <code>[X]</code> if you did, do the validation <b>before</b> sending the PR if you didn't</li> |
74 | 79 | <li><b>If you completed EVERY step in this list, you can finally open the PR</b></li> |
75 | 80 | </ul> |
76 | 81 | </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 |
| 82 | + <li><input type="checkbox">Now you can take a rest, help other people, make new friends... :)</li> |
| 83 | + <li><input type="checkbox">Your PR will be reviewed by other people, who will help make it even better |
79 | 84 | <ul> |
80 | | - <li>Make the changes and discuss the PR until it's approved</li> |
| 85 | + <li><input type="checkbox">Make the changes and discuss the PR until it's approved</li> |
81 | 86 | </ul> |
82 | 87 | </li> |
83 | | - <li>You should also review <a href="https://github.com/pandas-dev/pandas/pulls">other people PRs</a> |
| 88 | + <li><input type="checkbox">You should also review <a href="https://github.com/pandas-dev/pandas/pulls">other people PRs</a> |
84 | 89 | <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> |
| 90 | + <li><input type="checkbox">Be nice, concise and clear</li> |
| 91 | + <li><input type="checkbox">In general it's better of avoid comments in a PR with only "Thank you", "Understood", "I'll do it"...</li> |
87 | 92 | </ul> |
88 | 93 | </li> |
89 | 94 | </ol> |
90 | 95 | </div> |
91 | | - <div class="col-lg-6"> |
| 96 | + <div class="col-lg-4"> |
92 | 97 | <a class="twitter-timeline" href="https://twitter.com/hashtag/pandasSprint" data-widget-id="972275233502703616">#pandasSprint Tweets</a> |
93 | 98 | <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 | 99 |
|
|
0 commit comments