https://github.com/evrone/evrone_opensource

Improve READMEs of opensource projects
https://github.com/evrone/evrone_opensource

Last synced: about 1 year ago
JSON representation

Improve READMEs of opensource projects

• Host: GitHub
• URL: https://github.com/evrone/evrone_opensource
• Owner: evrone
• Created: 2020-04-24T19:52:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-02-08T13:10:39.000Z (over 5 years ago)
• Last Synced: 2025-04-05T18:51:39.379Z (about 1 year ago)
• Language: Ruby
• Homepage: https://evrone.com/cases#open-source
• Size: 243 KB
• Stars: 5
• Watchers: 10
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![CircleCI](https://circleci.com/gh/evrone/evrone_opensource.svg?style=svg)](https://app.circleci.com/pipelines/github/evrone/evrone_opensource)

[![Maintainability](https://api.codeclimate.com/v1/badges/3c2ddedd6fa03ab8eea3/maintainability)](https://codeclimate.com/github/evrone/evrone_opensource/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/3c2ddedd6fa03ab8eea3/test_coverage)](https://codeclimate.com/github/evrone/evrone_opensource/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

- [DevOps](docs/dev_ops.md)

## Resources

- [Production Docker Image](https://hub.docker.com/repository/docker/evrone/evrone_opensource)

## 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

```