Skip to content

Commit

Permalink
Improvements to the documentation and steps
Browse files Browse the repository at this point in the history
- It adds more details about what the app does
- It adds a reference to our CoC
- It simplifies setup steps
  • Loading branch information
etagwerker committed May 16, 2020
1 parent 8005c88 commit c7a51fc
Showing 1 changed file with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,37 @@
<img width="250" height="250" src="/logo/rubymem-logo.png">
</p>

[![Build Status](https://travis-ci.org/ombulabs/rubymem.com.svg?branch=master)](https://travis-ci.org/ombulabs/rubymem.com)
[![Build Status](https://travis-ci.org/rubymem/rubymem.com.svg?branch=master)](https://travis-ci.org/rubymem/rubymem.com)

Rails app that powers [rubymem.com](https://rubymem.com).

Pull requests welcome.
This is the Rails app that powers [RubyMem.com](https://RubyMem.com): A website
to submit new reports about gems which have memory leaks. Also, a nice way to
browse existing memory leak advisories.

## Setup

Requires ruby-2.3.1
Requires ruby-2.5 or higher, and Postgres.

./bin/setup

`bundle install`
### Seed

`bundle exec rake db:create db:migrate`
Setup steps will take care of this. If you want to reset your database, you
can remove all records from the database and then call:

### Load advisory database
```ruby
# inside a console
# ./bin/rails console
RubymemImporter.new.import!
```

### Run the tests
`bundle exec rake test`
## Testing

After making changes, make sure you run the test suite:

```
bundle exec rake test
```

## Collaboration

New issues and pull requests are welcome. Read our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before
submitting an issue or pull request. Thank you! ❤️

0 comments on commit c7a51fc

Please sign in to comment.