/evrone_opensource

Improve READMEs of opensource projects

Primary LanguageRuby

CircleCI Maintainability Test Coverage

Evrone Opensource

Improve READMEs of opensource projects.

This project scans GitHub and other sources for projects where README.md file can be improved.

On the next step, we fork and improve the readme (add syntax highlighting, fix formating and so on) in our forked repository.

Then we create a PR within cloned repository and after PR got approved by our team we propose changes to the original project.

Our mission is to make opensource projects better.

Documentation

Resources

Setup

  • GITHUB_ACCESS_TOKEN - token to access GitHub API
  • GIT_AUTHOR_EMAIL - email for creating commits
$ docker-compoer up
$ docker-compose exec app sh
$ rails s -b 0.0.0.0
$ rails test
$ rubocop