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

Improvement: pytest implementation, travis-ci for continuous integration, flake8 for style guide enforcement #41

Closed
nazrulworld opened this issue Aug 10, 2017 · 1 comment

Comments

@nazrulworld
Copy link

nazrulworld commented Aug 10, 2017

Hi @p2
I am Nazrul, I have some suggestions to make this wonderful product to be more explicit and standard.

  1. pytest: pytest is better than unittest and more powerful of course.
  2. For continuous integration we could use https://travis-ci.org/ as you know this is free for opensource project.
  3. flake8 http://flake8.pycqa.org/en/latest/ undoubtedly one of the best tool that is enforcing the best coding style.
  4. 100% code coverage: we code use https://coveralls.io/ for inspection.
  5. documentation improvement for developer as development guide .

I understand, you might be so busy, In that case I could manage some times, if you have agreement on those enhancements,

@mikix
Copy link
Contributor

mikix commented Jul 16, 2024

These are great ideas, of course. But might be better as separate tickets / PRs (and of course, I know I'm replying to an 8-year-old-offer-of-help).

  • pytest & CI is now used (via github actions, not travis)
  • flake8 or similar is a good idea - I know some members of the BCH dev team have been experimenting with ruff and liked it.
  • code coverage - we now generate a code coverage report for every PR, but don't yet enforce it (due to some issues with forked PRs)
  • documentation improvement is a lifelong goal for sure

The most actionable item remaining there is some sort of linting. I've filed #155 to track that specific ask.

@mikix mikix closed this as completed Jul 16, 2024
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