Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Naming, installation, documentation, tests, improvements #4

Open
valeriocos opened this issue Mar 8, 2020 · 1 comment
Open

Naming, installation, documentation, tests, improvements #4

valeriocos opened this issue Mar 8, 2020 · 1 comment

Comments

@valeriocos
Copy link
Collaborator

valeriocos commented Mar 8, 2020

The work done so far it's really good. However, the repo (which is a PoC ATM) could evolve to a mature tool. In this context, it may be worth improving:

  • naming: script.py and Maintenance tools for GrimoireLab are too vague. It would be better to look for more helpful/precise names (to let the user understand what the tool does).
  • installation: does it make sense to provide a setup.py to install the tool?
  • documentation: It would be great to add a complete example including how the tool is executed (already there), and what to do next with the output (e.g., git commit)
  • tests: although the tool is simple, it would be good to add some tests (and maybe coveralls and travis badges).
  • improvements: do you think it's possible to automate the use of the output of this tool? For instance, does the tool could automatically open a pull request in a target repository? How difficult could be to include the logic in a GitHub app, thus a bot could be registered to an organization to check that the copyright and authors correctly listed in the repo files?
@vchrombie
Copy link
Owner

Hi @valeriocos

Thank you for all your valuable suggestions. I would surely work on it to make it into a good tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants