search

openjournals / joss

The Journal of Open Source Software
https://joss.theoj.org
MIT License
1.55k stars 187 forks source link

Improve development environment & instructions. #1356

Closed sneakers-the-rat closed 3 months ago

sneakers-the-rat commented 3 months ago

Was trying to help out and debug https://github.com/openjournals/joss/issues/1346 since it seems like a pretty big problem, but had a tough time figuring out how to actually get a development environment set up.

I also was having a tough time figuring out the models and so i added the annotations gem to create model schemas as comments above the models, i've found this pretty dang helpful while working on mastodon.

Also added some seed data when seed is run in a development environment bc i also find this super helpful :). I don't know if there's a good way to use the factories from spec to populate this, but that obvi would be better - took me awhile to figure out how to create a paper until i looked there.

not sure why the schema removed the serial id, happened when i ran the migration.

xuanxu commented 3 months ago

In general we're against adding dependencies unless strictly needed. All the information added by the annotate gem can be found in the schema file.

The updated docs in the readme are fine though, can you open a PR with only that?

sneakers-the-rat commented 3 months ago

Dang even for dev dependencies? Thats a shame.