Page MenuHomeSoftware Heritage

Updated README.md for listers
ClosedPublic

Authored by nahimilega on Mar 19 2019, 6:47 PM.

Diff Detail

Repository
rDLS Listers
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

ardumont added a subscriber: ardumont.

Hello,

Nice to see this diff happening, cool.

Please, adapt according to my remarks and update the diff.

Also, don't forget to sign the document mentioned at the top of the diff ;)

Cheers,

README.md
92

Please, remove the extra blank space (same goes for the next command line below)

swh/lister/.vscode/launch.json
71 ↗(On Diff #4017)

Please, remove that file from the git history, that should not have been committed.

swh/lister/.vscode/settings.json
10 ↗(On Diff #4017)

Same goes for this file, it should be removed from the commit (and the diff).

This revision now requires changes to proceed.Mar 19 2019, 8:04 PM
  • Removed extra space from the README
  • Removed unnecessary files
  • Removed Extra blank space

I'll accept it because that's the perimeter we set out to fix.

For your information, the sample toplevels for the different listers are also out of date (it was mentioned earlier today in irc as well).

For example, the github lister should look like:

import logging
logging.basicConfig(level=logging.DEBUG)
from swh.lister.github.tasks import range_github_lister
range_github_lister(364, 365)
This revision is now accepted and ready to land.Mar 19 2019, 8:43 PM
This revision was automatically updated to reflect the committed changes.
nahimilega marked an inline comment as done.

@nahimilega I did not notice you made so much commits.

rDLSfa9113236442: Removed extra space from the README
rDLSbe804be0fcb4: Removed unnecessary files
rDLS26232db92666: Removed Extra blank space
rDLS5acb1fefc11e: Updated README.md for listers
rDLSd7ae2f1305c2: Updated README for listers

Next time, please rebase interactively and squash the commits together.
The change is small enough that i think it's not relevant to see so many actions in the git history.

Another nitpick is the use of the verb, be imperative, that reads better.

For example, here one commit with the following message would have been enough:

README: Update bootstrap db instructions

More information can be found at [1]

[1] https://wiki.softwareheritage.org/wiki/Git_style_guide

@ardumont Ok, from next time I will remove unnecessary commits and rebase interactively. And I will go through the Git_style_guide once again. Thanks for your feedback. I will surely remember this for future references.

@ardumont Ok, from next time I will remove unnecessary commits and rebase interactively. And I will go through the Git_style_guide once again. Thanks for your feedback. I will surely remember this for future references.

Cool.
Thanks again for your contribution already ;)
That's awesome.

Cheers,