54 mantainer guide #71
Conversation
Moved task_geo.data_sources.covid.fr_covidata -> task_geo.data_sources.covid.fr_covid and split in multiple files Moved task_geo.data_sources.covid.spain -> task_geo.data_sources.covid.es_covid Fixing issues with docstrings formatting on different modules Add example notebooks to the documentation index
There was a problem hiding this comment.
Mostly nitpicks, otherwise looks fine. However, you might want to call maintainer_guide CONTRIBUTING instead (that's what a lot of the bigger open source projects do).
Actually, might be nice to also add a guideline on branching etc. (e.g. only create branches, and if you fork, please don't use master branch for your changes... 😉 )
| Maintainer Guide | ||
| ================ | ||
|
|
||
| This document purpose is to define and concrete the tasks related to maintaining the github repository |
There was a problem hiding this comment.
| This document purpose is to define and concrete the tasks related to maintaining the github repository | |
| This document's purpose is to define and concrete the tasks related to maintaining this github repository |
(also not too sure 'concrete is the right word to use here 🤔 )
There was a problem hiding this comment.
To "concrete" doesn't exist afaik. Maybe "to concretely define", or "to define and make concrete".
| to have a detailed description of each of the task to serve as both: | ||
|
|
||
| 1. Reference for Mantainers of the repository | ||
| 2. Guide for users who may be interested in improve it's contribution workflow. |
There was a problem hiding this comment.
| 2. Guide for users who may be interested in improve it's contribution workflow. | |
| 2. Guide for users who may be interested in improving the contribution workflow. |
| This document purpose is to define and concrete the tasks related to maintaining the github repository | ||
| to have a detailed description of each of the task to serve as both: | ||
|
|
||
| 1. Reference for Mantainers of the repository |
There was a problem hiding this comment.
| 1. Reference for Mantainers of the repository | |
| 1. Reference for maintainers of the repository |
| pandas.DataFrame: Columns are country, region, sub_region (non-null), | ||
| lon, lat, date, and the desired data. | ||
|
|
||
| """ | ||
| if parms is None: | ||
| parms = list(PARAMETERS.keys()) |
There was a problem hiding this comment.
maybe fix spelling on this parms too?
| parms_str : string | ||
| Parameters: | ||
| lat(string) | ||
| lon(string) |
There was a problem hiding this comment.
hmm, is it just me but why do we want lat/lng as a str ? 👀
| """ | ||
| urlData = requests.get(url).content | ||
|
|
||
| return pd.read_csv(io.StringIO(urlData.decode('utf-8'))) |
There was a problem hiding this comment.
simpler if you just use pd.read_csv(url)... (and I've checked, it does work without having to specify anything else)
| everything is ok, we add the ``output-ok`` label and continue to the next step. | ||
|
|
||
| 4. **Peer review / Code review:** This is the final step, where we read the code and analyze it | ||
| looking for flaws, things that should be looked include: |
There was a problem hiding this comment.
| looking for flaws, things that should be looked include: | |
| for flaws. Things that should be considered include: |
| Pull requests | ||
| ------------- | ||
|
|
||
| Pull Requests are open by collaborators who whish their work to be included in the repository. |
There was a problem hiding this comment.
| Pull Requests are open by collaborators who whish their work to be included in the repository. | |
| Pull Requests are opened by collaborators who wish their work to be included in the repository. |
|
|
||
| 1. **Verification and design:** After receiving the feature request, we must make sure that the proposal: | ||
|
|
||
| a) Makes sense in the scope of this project and his motivations. |
There was a problem hiding this comment.
| a) Makes sense in the scope of this project and his motivations. | |
| a) Is within the scope of this project and its motivations. |
| Support issues came from users who tried to use our package but the the documentation ( or the | ||
| lack of thereof) wasn't helpful enough to get the results they wanted. | ||
|
|
||
| Usually this issues don't require developing code, just explaining the user how to use our package. |
There was a problem hiding this comment.
| Usually this issues don't require developing code, just explaining the user how to use our package. | |
| Usually to resolve these issues don't require developing code, just explaining to the user how to use our package. |
Description
Add a first version of the Maintainer Guide
Fixed issues that arise warnings on docs generation.
Linting docstrings a little.
Related to #54, but doesn't fix all the issues.
Checklist: