Community Action

[kpheasey]

We are starting an official/unofficial fork Netflix/fast_jsonapi. Until that project's maintainer is active, we will keep development going.

There are a few things we need to handle to make this successful.

• Migrate PR's from official repo.
  • It would be best to credit the original authors. Maybe we can contact everyone and give them 30 days to respond. Otherwise we will copy and give credit in some documentation?
  • Consider unforking...
• Determine how to handle gem releases
  • Putting a second gem on rubygems is not ideal. Unless someone needs the gem, using github releases might be sufficient.
• Setup PR review process
  • Status Checks
    • TravisCI
    • Codeclimate/Rubocop (not required)
    • Coveralls (ensure test coverage does not drop)
  • Maintainer assigns themselves and does a code review before merge
  • Squash PR (it's nice to cut down on noisy commits to pass status checks)
• Get 3 maintainers
  1. @jopotts
  2. @kpheasey
  3. @stas

[jopotts]

Thanks @kpheasey ! All good points above. 👍

To get the ball rolling, I've added the PR I had on the original repo which was easier than I'd thought.

To add Netflix/fast_jsonapi#411 for example, you can simply create a new PR direct from a URL like this: dev...krzysiek1507:maintenance/test-against-ruby-2-6 (cut & paste title and description)

ie. Paste the source branch after the 3 dots:
https://github.com/fast-jsonapi/fast_jsonapi/compare/dev...krzysiek1507:maintenance/test-against-ruby-2-6

I think it would be best to ask the original authors to do that. @krzysiek1507

For the release of gems, we should use the github release for now, with the purpose of this fork being to get PRs merged and things moving again, and then hopefully the guys at Netflix can either merge back or at least add other maintainers. Also it would be good to get more maintainers on this repo so it's more of a community effort.

[krzysiek1507]

Created #3. I hope it still works! ;)

[krzysiek1507]

Please let me know if you want my other PRs to be created for this repo. https://github.com/Netflix/fast_jsonapi/pulls/krzysiek1507

[kpheasey]

@krzysiek1507 Thanks for #3! Your other PR's look great too, please pull them over. Any interest in being a maintainer?

[krzysiek1507]

@kpheasey unfortunately, I don't have enough time for being a maintainer currently.

[kpheasey]

No worries, thanks for your contributions!

[krzysiek1507]

I've just created a few more PRs with fixes that I made a long time ago.

[kpheasey]

I merged in some of the PR's and await feedback on others. Additionally, master was behind dev, so I rebased it.

Don't know when I can setup all the status checks, but Travis is good for now.

[stas]

@kpheasey I'm very interested to be part of the reviews. Mainly, because of the https://github.com/stas/jsonapi.rb

I already subscribed to the notifications and will try to jump in when possible.

Determine how to handle gem releases

• Putting a second gem on rubygems is not ideal. Unless someone needs the gem, using github releases might be sufficient.

Since there are projects depending on the original gem, it won't be easy to manage the dependencies outside the rubygems. There are 4 people listed as maintainers on Rubygems, can we email them and ask for a proper update please? Alternatively just go for the faster_jsonapi 🙈

[kpheasey]

@stas Welcome aboard!

I have a similar project to yours that we use internally. Documentation is still a work in progress, it's a low priority because my team already knows it inside out. https://github.com/kp-software/jsonapi_actions

[kpheasey]

@jopotts @stas

I added a CHANGELOG

Also, I think we should switch to semantic versioning. Our first release should be 1.6.0, in a week or two once we have active PRs reviewed/merged.